- Add rtol argument in order to increase the precision of deSolve based

  predictions for complex models
- Improve default values for atol and set rtol default to 1e-10



git-svn-id: svn+ssh://svn.r-forge.r-project.org/svnroot/kinfit/pkg/mkin@49 edb9625f-4e0d-4859-8d74-9fd3b1da38cb

1 files changed, 17 insertions, 12 deletions

diff --git a/man/mkinpredict.Rd b/man/mkinpredict.Rd
index d2931443..a8ece47f 100644
--- a/man/mkinpredict.Rd
+++ b/man/mkinpredict.Rd
@@ -9,42 +9,47 @@
   initial values for the state variables.
 }
 \usage{
-mkinpredict(mkinmod, odeparms, odeini, outtimes, solution_type = "deSolve", map_output = TRUE, atol = 1e-06, ...)
+  mkinpredict(mkinmod, odeparms, odeini, outtimes, solution_type = "deSolve", map_output = TRUE, 
+	      atol = 1e-08, rtol = 1e-10, ...)
 }
 \arguments{
   \item{mkinmod}{
   A kinetic model as produced by \code{\link{mkinmod}}.
-}
+  }
   \item{odeparms}{
   A numeric vector specifying the parameters used in the kinetic model, which is generally
   defined as a set of ordinary differential equations.
-}
+  }
   \item{odeini}{
   A numeric vectory containing the initial values of the state variables of the model. Note
   that the state variables can differ from the observed variables, for example in the case
   of the SFORB model.
-}
+  }
   \item{outtimes}{
   A numeric vector specifying the time points for which model predictions should be 
   generated.
-}
+  }
   \item{solution_type}{
   The method that should be used for producing the predictions. This should
   generally be "analytical" if there is only one observed variable, and usually
   "deSolve" in the case of several observed variables. The third possibility "eigen"
   is faster but produces results that the author believes to be less accurate.
-}
+  }
   \item{map_output}{
   Boolean to specify if the output should list values for the observed variables (default)
   or for all state variables (if set to FALSE). 
-}
+  }
   \item{atol}{
-  Absolute error tolerance, passed to \code{\link{ode}}. Default is 1e-6 as in 
-  \code{\link{lsoda}}.
-}
+    Absolute error tolerance, passed to \code{\link{ode}}. Default is 1e-8,
+    lower than in \code{\link{lsoda}}.
+  }
+  \item{rtol}{
+    Absolute error tolerance, passed to \code{\link{ode}}. Default is 1e-10,
+    much lower than in \code{\link{lsoda}}.
+  }
   \item{\dots}{
-  Further arguments passed to the ode solver in case such a solver is used.
-}
+    Further arguments passed to the ode solver in case such a solver is used.
+  }
 }
 \value{
   A matrix in the same format as the output of \code{\link{ode}}.