aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2020-11-04 09:50:05 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2020-11-04 09:50:05 +0100
commit91ef22b6c98b96a9954dfe0a9914c45b41ce2af4 (patch)
treebff89f6d8a40b6b01fffc498317fb59ee914196b
parent9ce12eaeb40fc3b70cee39e679f120fcdf7e4696 (diff)
Update dynamic docs
-rw-r--r--R/saemix.R11
-rw-r--r--man/saemix.Rd11
2 files changed, 13 insertions, 9 deletions
diff --git a/R/saemix.R b/R/saemix.R
index ae534daa..f8714cf2 100644
--- a/R/saemix.R
+++ b/R/saemix.R
@@ -10,11 +10,12 @@
#' mmkin. Starting variances of the random effects (argument omega.init) are the
#' variances of the deviations of the parameters from these mean values.
#'
-#' @param object An mmkin row object containing several fits of the same model to different datasets
-#' @param cores The number of cores to be used for multicore processing. Using
-#' more than 1 core is experimental and may lead to uncontrolled forking,
-#' apparently depending on the BLAS version used. On Windows machines, cores
-#' > 1 is currently not supported.
+#' @param object An mmkin row object containing several fits of the same model
+#' to different datasets
+#' @param cores The number of cores to be used for multicore processing using
+#' [parallel::mclapply()]. Using more than 1 core is experimental and may
+#' lead to uncontrolled forking, apparently depending on the BLAS version
+#' used.
#' @rdname saemix
#' @importFrom saemix saemixData saemixModel
#' @importFrom stats var
diff --git a/man/saemix.Rd b/man/saemix.Rd
index 34ce8be1..962526ba 100644
--- a/man/saemix.Rd
+++ b/man/saemix.Rd
@@ -5,15 +5,18 @@
\alias{saemix_data}
\title{Create saemix models from mmkin row objects}
\usage{
-saemix_model(object, cores = parallel::detectCores())
+saemix_model(object, cores = 1)
saemix_data(object, ...)
}
\arguments{
-\item{object}{An mmkin row object containing several fits of the same model to different datasets}
+\item{object}{An mmkin row object containing several fits of the same model
+to different datasets}
-\item{cores}{The number of cores to be used for multicore processing.
-On Windows machines, cores > 1 is currently not supported.}
+\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
+used.}
\item{\dots}{Further parameters passed to \link[saemix:saemixData]{saemix::saemixData}}
}

Contact - Imprint