From a76221d87485029444c8e684022ca606a0c7e68d Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 18 Jan 2017 22:41:01 +0100 Subject: Update static docs using pkgdown - Add _pkgdown.yml for a structured function/data reference - Make seealso links active - Make mkinfit calls quiet - Use pkgdown branch from pull request hadley/pkgdown#229 to have topics ordered --- docs/reference/twa.html | 138 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 docs/reference/twa.html (limited to 'docs/reference/twa.html') diff --git a/docs/reference/twa.html b/docs/reference/twa.html new file mode 100644 index 0000000..414b372 --- /dev/null +++ b/docs/reference/twa.html @@ -0,0 +1,138 @@ + + + + + + + + +Calculate a time weighted average concentration — twa • pfm + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Calculate a time weighted average concentration

+
+ + +

The moving average is built only using the values in the past, so +the earliest possible time for the maximum in the time series returned +is after one window has passed.

+ + + 
twa(x, window = 21)
+
+# S3 method for one_box
+twa(x, window = 21)
+ +

Arguments

+
+
x
+
An object of type one_box
+
window
+
The size of the moving window
+
+ +

See also

+ +

max_twa

+ + +

Examples

+ 
pred <- sawtooth(one_box(10),
+  applications = data.frame(time = c(0, 7), amount = c(1, 1)))
+max_twa(pred)
#> $max
+#>    parent 
+#> 0.9537545 
+#> 
+#> $window_start
+#> parent 
+#>      0 
+#> 
+#> $window_end
+#> parent 
+#>     21 
+#>
+
+ +
+ + +
+ + + -- cgit v1.2.1