aboutsummaryrefslogtreecommitdiff
path: root/man/one_box.Rd
blob: 5a46142d04b0f1451b0316366e7075eaa14aebfd (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
% 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.character}
\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}{character}(x, parms, ..., 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{...}{Further arguments passed to methods}

\item{t_end}{End of the time series}

\item{res}{Resolution of the time series}

\item{parms}{A named numeric vector containing the model parameters}
}
\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, 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"))
fit_2 <- mkinfit(m_2, FOCUS_2006_D, quiet = TRUE)
pred_2 <- one_box(fit_2)
plot(pred_2)
}

Contact - Imprint