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/sawtooth.html | 142 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 142 insertions(+) create mode 100644 docs/reference/sawtooth.html (limited to 'docs/reference/sawtooth.html') diff --git a/docs/reference/sawtooth.html b/docs/reference/sawtooth.html new file mode 100644 index 0000000..e24186e --- /dev/null +++ b/docs/reference/sawtooth.html @@ -0,0 +1,142 @@ + + + + + + + + +Create decline time series for multiple applications — sawtooth • pfm + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Create decline time series for multiple applications

+
+ + +

If the number of application cycles n is greater than 1, the +application pattern specified in applications is repeated n +times, with an interval i.

+ + + 
sawtooth(x, n = 1, i = 365, applications = data.frame(time = seq(0, 0 + n
+  * i, length.out = n), amount = 1))
+ +

Arguments

+
+
x
+
A one_box object
+
n
+
The number of applications. If applications is specified, n is not used
+
i
+
The interval between applications. If applications is specified, i +is not used
+
applications
+
A data frame holding the application times in the first column and +the corresponding amounts applied in the second column for each application cycle. +If n is one, the application pattern specified here is used only once.
+
+ + +

Examples

+ 
applications = data.frame(time = seq(0, 14, by = 7), amount = c(1, 2, 3))
+pred <- one_box(10)
+plot(sawtooth(pred, applications = applications))

+m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
#> Successfully compiled differential equation model from auto-generated C code.
fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE)
+pred_2 <- one_box(fit_2)
+pred_2_saw <- sawtooth(pred_2, 2, 7)
+plot(pred_2_saw, max_twa = 21, max_twa_var = "m1")

+max_twa(pred_2_saw)
#> $max
+#>    parent        m1 
+#> 0.6627707 0.8542785 
+#> 
+#> $window_start
+#> parent     m1 
+#>   0.00  32.09 
+#> 
+#> $window_end
+#> parent     m1 
+#>  21.00  53.09 
+#>
+
+ +
+ + +
+ + + -- cgit v1.2.1