aboutsummaryrefslogtreecommitdiff
path: root/man/one_box.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-01-19 11:41:19 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2017-01-19 11:41:19 +0100
commit2ab822d51c4c7e29d62076336d7a3f02a46e41a5 (patch)
treeb9836a7318d92bc73e96dfd8a943986fa3f3cee7 /man/one_box.Rd
parent46883a0c3a3c00127a563a7befa0af440573baaa (diff)
Corrections in the documentation
Diffstat (limited to 'man/one_box.Rd')
-rw-r--r--man/one_box.Rd20
1 files changed, 14 insertions, 6 deletions
diff --git a/man/one_box.Rd b/man/one_box.Rd
index 1bdc791..134b206 100644
--- a/man/one_box.Rd
+++ b/man/one_box.Rd
@@ -14,14 +14,20 @@ one_box(x, ini, ..., t_end = 100, res = 0.01)
\method{one_box}{character}(x, ini = 1, parms, ..., t_end = 100,
res = 0.01)
-\method{one_box}{mkinfit}(x, ini = c("model", 1), ..., t_end = 100,
- res = 0.01)
+\method{one_box}{mkinfit}(x, ini = "model", ..., 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}
+decline. When a character string specifying a parent decline model is given
+e.g. \code{FOMC}, \code{parms} must contain the corresponding paramters.
+If x is an \code{\link{mkinfit}} object, the decline is calculated from this
+object.}
-\item{ini}{The initial amount for each compound}
+\item{ini}{The initial amount for the parent compound. If x is an
+\code{\link{mkinfit}} object, and ini is 'model', the fitted initial
+concentrations are used. Otherwise, ini must be numeric. If it has
+length one, it is used for the parent and initial values of metabolites
+are zero, otherwise, it must give values for all observed variables.}
\item{...}{Further arguments passed to methods}
@@ -31,9 +37,11 @@ decline. If x is an mkinfit object, the decline is calculated from this object}
\item{parms}{A named numeric vector containing the model parameters}
}
+\value{
+An object of class \code{one_box}, inheriting from \code{\link{ts}}.
+}
\description{
-The time series starts with the amount specified for the first application.
-This does not create objects of type \code{\link{ts}}.
+Create a time series of decline data
}
\examples{
# Only use a half-life

Contact - Imprint