aboutsummaryrefslogtreecommitdiff
path: root/man/saem.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2020-11-11 19:49:25 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2020-11-11 19:49:25 +0100
commitc0c82d9523da8965f5fb7a5f8cf1410750885d30 (patch)
tree8db6015dfa8eb14df8318b9661b07424bb92620f /man/saem.Rd
parente13189e6a34d87fabf650c777d0432057bcacbb9 (diff)
Update static docs
Diffstat (limited to 'man/saem.Rd')
-rw-r--r--man/saem.Rd14
1 files changed, 9 insertions, 5 deletions
diff --git a/man/saem.Rd b/man/saem.Rd
index c37fbcfe..3cd9f7f8 100644
--- a/man/saem.Rd
+++ b/man/saem.Rd
@@ -1,5 +1,5 @@
% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/saemix.R
+% Please edit documentation in R/saem.R
\name{saem}
\alias{saem}
\alias{saem.mmkin}
@@ -17,6 +17,7 @@ saem(object, control, ...)
cores = 1,
verbose = FALSE,
suppressPlot = TRUE,
+ quiet = FALSE,
...
)
@@ -32,19 +33,22 @@ saemix_data(object, verbose = FALSE, ...)
\item{control}{Passed to \link[saemix:saemix]{saemix::saemix}}
-\item{\dots}{Further parameters passed to \link[saemix:saemixData]{saemix::saemixData}
-and \link[saemix:saemixModel]{saemix::saemixModel}.}
+\item{\dots}{Further parameters passed to \link[saemix:saemixModel]{saemix::saemixModel}.}
\item{cores}{The number of cores to be used for multicore processing using
\code{\link[parallel:mclapply]{parallel::mclapply()}}. Using more than 1 core is experimental and may
-lead to uncontrolled forking, apparently depending on the BLAS version
+lead to excessive forking, apparently depending on the BLAS version
used.}
-\item{verbose}{Should we print information about created objects?}
+\item{verbose}{Should we print information about created objects of
+type \link[saemix:SaemixModel-class]{saemix::SaemixModel} and \link[saemix:SaemixData-class]{saemix::SaemixData}?}
\item{suppressPlot}{Should we suppress any plotting that is done
by the saemix function?}
+\item{quiet}{Should we suppress the messages saemix prints at the beginning
+and the end of the optimisation process?}
+
\item{x}{An saem.mmkin object to print}
\item{digits}{Number of digits to use for printing}

Contact - Imprint