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

Create a time series of decline data

+
+ + +

The time series starts with the amount specified for the first application. +This does not create objects of type ts.

+ + + 
one_box(x, t_end = 100, res = 0.01, ...)
+
+# S3 method for numeric
+one_box(x, t_end = 100, res = 0.01, ...)
+
+# S3 method for mkinfit
+one_box(x, t_end = 100, res = 0.01, ...)
+ +

Arguments

+
+
x
+
When numeric, this is the half-life to be used for an exponential +decline. If x is an mkinfit object, the decline is calculated from this object
+
t_end
+
End of the time series
+
res
+
Resolution of the time series
+
...
+
Further arguments passed to methods
+
+ + +

Examples

+ 
# Only use a half-life
+pred_0 <- one_box(10)
+plot(pred_0)

+# Use a fitted mkinfit model
+require(mkin)
+fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
+pred_1 <- one_box(fit)
+plot(pred_1)

+# Use a model with more than one observed variable
+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)
+plot(pred_2)
+
+ +
+ + +
+ + + -- cgit v1.2.1