From e0c130005ee7adbac9b832ea8157712419d51b7e Mon Sep 17 00:00:00 2001
From: Ranke Johannes <johannes.ranke@agroscope.admin.ch>
Date: Mon, 22 Jun 2026 18:01:11 +0200
Subject: Update static docs

---
 docs/reference/twa.md | 49 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 49 insertions(+)
 create mode 100644 docs/reference/twa.md

(limited to 'docs/reference/twa.md')

diff --git a/docs/reference/twa.md b/docs/reference/twa.md
new file mode 100644
index 0000000..5c3a4ea
--- /dev/null
+++ b/docs/reference/twa.md
@@ -0,0 +1,49 @@
+# 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.
+
+## Usage
+
+``` r
+twa(x, window = 21)
+
+# S3 method for class 'one_box'
+twa(x, window = 21)
+```
+
+## Arguments
+
+- x:
+
+  An object of type
+  [one_box](https://pkgdown.jrwb.de/pfm/reference/one_box.md)
+
+- window:
+
+  The size of the moving window
+
+## See also
+
+[`max_twa`](https://pkgdown.jrwb.de/pfm/reference/max_twa.md)
+
+## Examples
+
+``` r
+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.3