1 files changed, 39 insertions, 14 deletions
diff --git a/man/saemix.Rd b/man/saemix.Rd
index d4a8d0a4..1959817a 100644
--- a/man/saemix.Rd
+++ b/man/saemix.Rd
@@ -1,41 +1,65 @@
 % Generated by roxygen2: do not edit by hand
 % Please edit documentation in R/saemix.R
-\name{saemix_model}
+\name{saemix}
+\alias{saemix}
+\alias{saemix.mmkin}
 \alias{saemix_model}
 \alias{saemix_data}
-\title{Create saemix models from mmkin row objects}
+\title{Create saemix models}
 \usage{
-saemix_model(object, cores = 1)
+saemix(model, data, control, ...)
 
-saemix_data(object, ...)
+\method{saemix}{mmkin}(
+  model,
+  data,
+  control = list(displayProgress = FALSE, print = FALSE, save = FALSE, save.graphs =
+    FALSE),
+  verbose = FALSE,
+  ...
+)
+
+saemix_model(object, cores = 1, verbose = FALSE, ...)
+
+saemix_data(object, verbose = FALSE, ...)
 }
 \arguments{
-\item{object}{An mmkin row object containing several fits of the same model
-to different datasets}
+\item{model}{For the default method, this is an \link[saemix:saemixModel]{saemix::saemixModel} object.
+If this is an \link{mmkin} row object, the \link[saemix:saemixModel]{saemix::saemixModel} is created
+internally from the \link{mmkin} object.}
+
+\item{\dots}{Further parameters passed to \link[saemix:saemixData]{saemix::saemixData}
+and \link[saemix:saemixModel]{saemix::saemixModel}.}
+
+\item{verbose}{Should we print information about created objects?}
+
+\item{object}{An \link{mmkin} row object containing several fits of the same
+\link{mkinmod} model to different datasets}
 
 \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}}
 }
 \value{
+An \link[saemix:SaemixObject-class]{saemix::SaemixObject}.
+
 An \link[saemix:SaemixModel-class]{saemix::SaemixModel} object.
 
 An \link[saemix:SaemixData-class]{saemix::SaemixData} object.
 }
 \description{
-This function sets up a nonlinear mixed effects model for an mmkin row
-object for use with the saemix package. An mmkin row object is essentially a
-list of mkinfit objects that have been obtained by fitting the same model to
-a list of datasets.
+The saemix function defined in this package is an S3 generic function
+using \code{\link[saemix:saemix]{saemix::saemix()}} as its method for \link[saemix:SaemixModel-class]{saemix::SaemixModel} objects.
 }
 \details{
+The method for mmkin row objects sets up a nonlinear mixed effects model for
+use with the saemix package. An mmkin row object is essentially a list of
+mkinfit objects that have been obtained by fitting the same model to
+a list of datasets.
+
 Starting values for the fixed effects (population mean parameters, argument psi0 of
 \code{\link[saemix:saemixModel]{saemix::saemixModel()}} are the mean values of the parameters found using
-mmkin. Starting variances of the random effects (argument omega.init) are the
-variances of the deviations of the parameters from these mean values.
+\link{mmkin}.
 }
 \examples{
 \dontrun{
@@ -45,6 +69,7 @@ ds <- lapply(experimental_data_for_UBA_2019[6:10],
 names(ds) <- paste("Dataset", 6:10)
 f_mmkin_parent_p0_fixed <- mmkin("FOMC", ds, cores = 1,
   state.ini = c(parent = 100), fixed_initials = "parent", quiet = TRUE)
+f_saemix_p0_fixed <- saemix(f_mmkin_parent_p0_fixed)
 m_saemix_p0_fixed <- saemix_model(f_mmkin_parent_p0_fixed["FOMC", ])
 d_saemix_parent <- saemix_data(f_mmkin_parent_p0_fixed)
 saemix_options <- list(seed = 123456, displayProgress = FALSE,