diff options
Diffstat (limited to 'man/one_box.Rd')
-rw-r--r-- | man/one_box.Rd | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/man/one_box.Rd b/man/one_box.Rd new file mode 100644 index 0000000..86440ce --- /dev/null +++ b/man/one_box.Rd @@ -0,0 +1,45 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/twa.R +\name{one_box} +\alias{one_box} +\alias{one_box.numeric} +\alias{one_box.mkinfit} +\title{Create a time series of decline data} +\usage{ +one_box(x, t_end = 100, res = 0.01, ...) + +\method{one_box}{numeric}(x, t_end = 100, res = 0.01, ...) + +\method{one_box}{mkinfit}(x, t_end = 100, res = 0.01, ...) +} +\arguments{ +\item{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} + +\item{t_end}{End of the time series} + +\item{res}{Resolution of the time series} + +\item{...}{Further arguments passed to methods} +} +\description{ +The time series starts with the amount specified for the first application. +This does not create objects of type \code{\link{ts}}. +} +\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) +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")) +fit_2 <- mkinfit(m_2, FOCUS_2006_D) +pred_2 <- one_box(fit_2) +plot(pred_2) +} |