From 803fe13e505960fddccdbd4dcb524715f5eb068d Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 18 Sep 2019 18:18:40 +0200 Subject: Add url: tag to _pkgdown.yml, typo, update docs --- docs/reference/one_box.html | 44 +++++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 21 deletions(-) (limited to 'docs/reference/one_box.html') diff --git a/docs/reference/one_box.html b/docs/reference/one_box.html index e7379e2..ebfb872 100644 --- a/docs/reference/one_box.html +++ b/docs/reference/one_box.html @@ -16,13 +16,15 @@ - + + - - + + + @@ -47,6 +49,7 @@ + @@ -71,7 +74,7 @@ @@ -94,13 +92,14 @@ +

Create a time series of decline data

- Source: R/twa.R +
@@ -130,7 +129,7 @@ x

When numeric, this is the half-life to be used for an exponential decline. When a character string specifying a parent decline model is given -e.g. FOMC, parms must contain the corresponding paramters. +e.g. FOMC, parms must contain the corresponding parameters. If x is an mkinfit object, the decline is calculated from this object.

@@ -162,22 +161,21 @@ all observed variables.

Value

-

An object of class one_box, inheriting from ts.

+

An object of class one_box, inheriting from ts.

Examples

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

+plot(pred_0)

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

+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, ini = "model")
-plot(pred_2)
+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
pred_2 <- one_box(fit_2, ini = "model") +plot(pred_2)
+ + + -- cgit v1.2.1