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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
\name{mkinmod}
\alias{mkinmod}
\title{
Function to set up a kinetic model with one or more state variables.
}
\description{
The function usually takes several expressions, each assigning a compound name to
a list, specifying the kinetic model type and reaction or transfer to other
observed compartments. Instead of specifying several expressions, a list
of lists can be given in the speclist argument.
For the definition of model types and their parameters, the equations given
in the FOCUS and NAFTA guidance documents are used.
When a C++ compiler is available (currently checking for g++), the model is
compiled using the \code{\link{odeintr}} package, so that model fitting will
be faster.
}
\usage{
mkinmod(..., use_of_ff = "min", speclist = NULL, quiet = FALSE,
odeintr_compile = c("auto", "no", "yes"),
odeintr_method = "rk5_i",
odeintr_atol = 1e-8, odeintr_rtol = 1e-10)
}
\arguments{
\item{...}{
For each observed variable, a list has to be specified as an argument, containing
at least a component \code{type}, specifying the type of kinetics to use
for the variable. Currently, single first order kinetics "SFO",
indeterminate order rate equation kinetics "IORE", or
single first order with reversible binding "SFORB" are implemented for all
variables, while
"FOMC", "DFOP" and "HS" can additionally be chosen for the first
variable which is assumed to be the source compartment.
Additionally, each component of the list can include a character vector \code{to},
specifying names of variables to which a transfer is to be assumed in the
model.
If the argument \code{use_of_ff} is set to "min" (default) and the model for
the compartment is "SFO" or "SFORB", an additional component of the list
can be "sink=FALSE" effectively fixing the flux to sink to zero.
}
\item{use_of_ff}{
Specification of the use of formation fractions in the model equations and, if
applicable, the coefficient matrix. If "min", a minimum use of formation
fractions is made in order to avoid fitting the product of formation fractions
and rate constants. If "max", formation fractions are always used.
}
\item{speclist}{
The specification of the observed variables and their submodel types and
pathways can be given as a single list using this argument. Default is NULL.
}
\item{quiet}{
Should messages be suppressed?
}
\item{odeintr_compile}{
When "no", the model is not compiled using \code{\link{compile_sys}}.
When "auto", it is only compiled when an eigenvalue based solution
is not possible, as compiling the model takes some time and we
want to avoid this in case it does not bring a large performance benefit.
}
\item{odeintr_method}{
The integration method passed to \code{\link{compile_sys}}. The default "rk5_i"
is an interpolating adaptive method.
}
\item{odeintr_atol}{
Absolute error tolerance, only used when the model is compiled using the odeintr
package. Default is 1e-8, lower than in \code{\link{compile_sys}}.
}
\item{odeintr_rtol}{
Relative error tolerance, only used when the model is compiled using the odeintr
package. Default is 1e-10, lower than in \code{\link{compile_sys}}.
}
}
\value{
A list of class \code{mkinmod} for use with \code{\link{mkinfit}}, containing
\item{diffs}{ A vector of string representations of differential equations,
one for each modelling variable. }
\item{parms}{ A vector of parameter names occurring in the differential equations. }
\item{map}{ A list containing named character vectors for each observed variable, specifying
the modelling variables by which it is represented. }
\item{use_of_ff}{ The content of \code{use_of_ff} is passed on in this list component. }
\item{coefmat}{ The coefficient matrix, if the system of differential equations can be
represented by one. }
\item{e}{An environment where the functions generated by \{code\{link{compile_sys}}
are installed when the model is compiled. The name used for the model is "m", so
for example the function for setting parameters is e$m_set_params(). See
the help page for \code{\link{compile_sys}} for the available functions
and their arguments.
}
\note{
The IORE submodel is not well tested (yet). When using this model for metabolites,
you may want to read the second note in the help page to
\code{\link{mkinfit}}.
}
\references{
FOCUS (2006) \dQuote{Guidance Document on Estimating Persistence and
Degradation Kinetics from Environmental Fate Studies on Pesticides in EU
Registration} Report of the FOCUS Work Group on Degradation Kinetics,
EC Document Reference Sanco/10058/2005 version 2.0, 434 pp,
\url{http://focus.jrc.ec.europa.eu/dk}
NAFTA Technical Working Group on Pesticides (not dated) Guidance for
Evaluating and Calculating Degradation Kinetics in Environmental
Media
}
\author{
Johannes Ranke
}
\examples{
# Specify the SFO model (this is not needed any more, as we can now mkinfit("SFO", ...)
SFO <- mkinmod(parent = list(type = "SFO"))
# One parent compound, one metabolite, both single first order.
SFO_SFO <- mkinmod(
parent = mkinsub("SFO", "m1"),
m1 = mkinsub("SFO"))
# The above model used to be specified like this, before the advent of mkinsub()
SFO_SFO <- mkinmod(
parent = list(type = "SFO", to = "m1"),
m1 = list(type = "SFO"))
# If we have several parallel metabolites
# (compare tests/testthat/test_synthetic_data_for_UBA_2014.R)
\dontrun{
m_synth_DFOP_par <- mkinmod(parent = mkinsub("DFOP", c("M1", "M2")),
M1 = mkinsub("SFO"),
M2 = mkinsub("SFO"),
use_of_ff = "max", quiet = TRUE)
fit_DFOP_par_c <- mkinfit(m_synth_DFOP_par,
synthetic_data_for_UBA_2014[[12]]$data,
quiet = TRUE)
}
}
\keyword{ models }
|
