From d66bd4aa0bf9c4d9b8793a4e308c9e80691b440f Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Sun, 12 Nov 2023 21:40:01 +0100 Subject: Enable links to source, upgrade to bootstrap 5 --- docs/reference/sawtooth.html | 271 +++++++++++++++++-------------------------- 1 file changed, 105 insertions(+), 166 deletions(-) (limited to 'docs/reference/sawtooth.html') diff --git a/docs/reference/sawtooth.html b/docs/reference/sawtooth.html index fea24d4..d22afa4 100644 --- a/docs/reference/sawtooth.html +++ b/docs/reference/sawtooth.html @@ -1,194 +1,133 @@ - - - - - - - -Create decline time series for multiple applications — sawtooth • pfm - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +Create decline time series for multiple applications — sawtooth • pfm + Skip to contents + +
+
+
+

Create decline time series for multiple applications

+ Source: R/twa.R +
sawtooth.Rd
-
+

If the application pattern is specified in applications, n and i are disregarded.

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

Arguments

- - - - - - - - - - - - - - - - - - -
x

A one_box object

n

The number of applications. If applications is specified, n is ignored

i

The interval between applications. If applications is specified, i -is ignored

applications

A data frame holding the application times in the first column and -the corresponding amounts applied in the second column.

- - -

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)
#> Warning: Observations with value of zero were removed from the data
#> Warning: Shapiro-Wilk test for standardized residuals: p =  0.0165
pred_2 <- one_box(fit_2, ini = 1)
-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.7834480 0.8617048 
-#> 
-#> $window_start
-#> parent     m1 
-#>   0.00  26.85 
-#> 
-#> $window_end
-#> parent     m1 
-#>  21.00  47.85 
-#>
-
- -
+
+

Usage

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

Arguments

+
x
+

A one_box object

+ + +
n
+

The number of applications. If applications is specified, n is ignored

+ + +
i
+

The interval between applications. If applications is specified, i +is ignored

+ + +
applications
+

A data frame holding the application times in the first column and +the corresponding amounts applied in the second column.

+ +
+ +
+

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"))
+#> Temporary DLL for differentials generated and loaded
+fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE)
+#> Warning: Observations with value of zero were removed from the data
+pred_2 <- one_box(fit_2, ini = 1)
+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.7834481 0.8617049 
+#> 
+#> $window_start
+#> parent     m1 
+#>   0.00  26.85 
+#> 
+#> $window_end
+#> parent     m1 
+#>  21.00  47.85 
+#> 
+
+
+
- + - - - + -- cgit v1.2.1