diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/mkinfit.Rd | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/man/mkinfit.Rd b/man/mkinfit.Rd index b8d44fba..5e6b242e 100644 --- a/man/mkinfit.Rd +++ b/man/mkinfit.Rd @@ -32,7 +32,7 @@ mkinfit( ) } \arguments{ -\item{mkinmod}{A list of class \code{\link{mkinmod}}, containing the kinetic +\item{mkinmod}{A list of class \link{mkinmod}, containing the kinetic model to be fitted to the data, or one of the shorthand names ("SFO", "FOMC", "DFOP", "HS", "SFORB", "IORE"). If a shorthand name is given, a parent only degradation model is generated for the variable with the @@ -63,7 +63,7 @@ given below.} \item{state.ini}{A named vector of initial values for the state variables of the model. In case the observed variables are represented by more than one model variable, the names will differ from the names of the observed -variables (see \code{map} component of \code{\link{mkinmod}}). The default +variables (see \code{map} component of \link{mkinmod}). The default is to set the initial value of the first model variable to the mean of the time zero values for the variable with the maximum observed value, and all others to 0. If this variable has no time zero observations, its initial @@ -92,23 +92,22 @@ observed mean value is the new time zero.} \item{solution_type}{If set to "eigen", the solution of the system of differential equations is based on the spectral decomposition of the coefficient matrix in cases that this is possible. If set to "deSolve", a -numerical ode solver from package \code{\link{deSolve}} is used. If set to -"analytical", an analytical solution of the model is used. This is only -implemented for relatively simple degradation models. The default is +numerical \link[deSolve:ode]{ode solver from package deSolve} is used. If +set to "analytical", an analytical solution of the model is used. This is +only implemented for relatively simple degradation models. The default is "auto", which uses "analytical" if possible, otherwise "deSolve" if a compiler is present, and "eigen" if no compiler is present and the model -can be expressed using eigenvalues and eigenvectors. This argument is -passed on to the helper function \code{\link{mkinpredict}}.} +can be expressed using eigenvalues and eigenvectors.} -\item{method.ode}{The solution method passed via \code{\link{mkinpredict}} -to \code{\link{ode}} in case the solution type is "deSolve". The default +\item{method.ode}{The solution method passed via \code{\link[=mkinpredict]{mkinpredict()}} +to \code{\link[deSolve:ode]{deSolve::ode()}} in case the solution type is "deSolve". The default "lsoda" is performant, but sometimes fails to converge.} \item{use_compiled}{If set to \code{FALSE}, no compiled version of the -\code{\link{mkinmod}} model is used in the calls to -\code{\link{mkinpredict}} even if a compiled version is present.} +\link{mkinmod} model is used in the calls to \code{\link[=mkinpredict]{mkinpredict()}} even if a compiled +version is present.} -\item{control}{A list of control arguments passed to \code{\link{nlminb}}.} +\item{control}{A list of control arguments passed to \code{\link[stats:nlminb]{stats::nlminb()}}.} \item{transform_rates}{Boolean specifying if kinetic rate constants should be transformed in the model specification used in the fitting for better @@ -124,16 +123,17 @@ fitting for better compliance with the assumption of normal distribution of the estimator. The default (TRUE) is to do transformations. If TRUE, the g parameter of the DFOP and HS models are also transformed, as they can also be seen as compositional data. The transformation used for these -transformations is the \code{\link{ilr}} transformation.} +transformations is the \code{\link[=ilr]{ilr()}} transformation.} \item{quiet}{Suppress printing out the current value of the negative log-likelihood after each improvement?} -\item{atol}{Absolute error tolerance, passed to \code{\link{ode}}. Default -is 1e-8, lower than in \code{\link{lsoda}}.} +\item{atol}{Absolute error tolerance, passed to \code{\link[deSolve:ode]{deSolve::ode()}}. Default +is 1e-8, which is lower than the default in the \code{\link[deSolve:lsoda]{deSolve::lsoda()}} +function which is used per default.} -\item{rtol}{Absolute error tolerance, passed to \code{\link{ode}}. Default -is 1e-10, much lower than in \code{\link{lsoda}}.} +\item{rtol}{Absolute error tolerance, passed to \code{\link[deSolve:ode]{deSolve::ode()}}. Default +is 1e-10, much lower than in \code{\link[deSolve:lsoda]{deSolve::lsoda()}}.} \item{error_model}{If the error model is "const", a constant standard deviation is assumed. @@ -187,17 +187,18 @@ the error model parameters in IRLS fits.} \item{trace_parms}{Should a trace of the parameter values be listed?} \item{\dots}{Further arguments that will be passed on to -\code{\link{deSolve}}.} +\code{\link[deSolve:ode]{deSolve::ode()}}.} } \value{ -A list with "mkinfit" in the class attribute. A summary can be -obtained by \code{\link{summary.mkinfit}}. +A list with "mkinfit" in the class attribute. } \description{ This function maximises the likelihood of the observed data using the Port -algorithm \code{\link{nlminb}}, and the specified initial or fixed +algorithm \code{\link[stats:nlminb]{stats::nlminb()}}, and the specified initial or fixed parameters and starting values. In each step of the optimisation, the -kinetic model is solved using the function \code{\link{mkinpredict}}. The +kinetic model is solved using the function \code{\link[=mkinpredict]{mkinpredict()}}, except +if an analytical solution is implemented, in which case the model is solved +using the degradation function in the \link{mkinmod} object. The parameters of the selected error model are fitted simultaneously with the degradation model parameters, as both of them are arguments of the likelihood function. @@ -285,8 +286,7 @@ Degradation Data. \emph{Environments} 6(12) 124 \href{https://doi.org/10.3390/environments6120124}{doi:10.3390/environments6120124}. } \seealso{ -Plotting methods \code{\link{plot.mkinfit}} and -\code{\link{mkinparplot}}. +\link{summary.mkinfit}, \link{plot.mkinfit}, \link{parms} and \link{lrtest}. Comparisons of models fitted to the same data can be made using \code{\link{AIC}} by virtue of the method \code{\link{logLik.mkinfit}}. |