aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
Diffstat (limited to 'man')
-rw-r--r--man/one_box.Rd5
-rw-r--r--man/plot.one_box.Rd12
2 files changed, 14 insertions, 3 deletions
diff --git a/man/one_box.Rd b/man/one_box.Rd
index 0085f3f..dc524a8 100644
--- a/man/one_box.Rd
+++ b/man/one_box.Rd
@@ -3,6 +3,7 @@
\name{one_box}
\alias{one_box}
\alias{one_box.numeric}
+\alias{one_box.character}
\alias{one_box.mkinfit}
\title{Create a time series of decline data}
\usage{
@@ -10,6 +11,8 @@ one_box(x, t_end = 100, res = 0.01, ...)
\method{one_box}{numeric}(x, t_end = 100, res = 0.01, ...)
+\method{one_box}{character}(x, parms, t_end = 100, res = 0.01, ...)
+
\method{one_box}{mkinfit}(x, t_end = 100, res = 0.01, ...)
}
\arguments{
@@ -21,6 +24,8 @@ decline. If x is an mkinfit object, the decline is calculated from this object}
\item{res}{Resolution of the time series}
\item{...}{Further arguments passed to methods}
+
+\item{parms}{A named numeric vector containing the model parameters}
}
\description{
The time series starts with the amount specified for the first application.
diff --git a/man/plot.one_box.Rd b/man/plot.one_box.Rd
index 6245b4c..e2c9a42 100644
--- a/man/plot.one_box.Rd
+++ b/man/plot.one_box.Rd
@@ -31,9 +31,15 @@ be shown if max_twa is not NULL.}
Plot time series of decline data
}
\examples{
-fomc_fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
-fomc_pred <- one_box(fomc_fit)
-plot(sawtooth(fomc_pred, 3, 7), max_twa = 21)
+dfop_pred <- one_box("DFOP", parms = c(k1 = 0.2, k2 = 0.02, g = 0.7))
+plot(dfop_pred)
+plot(sawtooth(dfop_pred, 3, 7), max_twa = 21)
+
+# Use a fitted mkinfit model
+m_2 <- mkinmod(parent = mkinsub("SFO", "m1"), m1 = mkinsub("SFO"))
+fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE)
+pred_2_saw <- sawtooth(pred_2, 2, 7)
+plot(pred_2_saw, max_twa = 21, max_twa_var = "m1")
}
\seealso{
\code{\link{sawtooth}}

Contact - Imprint