diff options
Diffstat (limited to 'man/mmkin.Rd')
-rw-r--r-- | man/mmkin.Rd | 76 |
1 files changed, 37 insertions, 39 deletions
diff --git a/man/mmkin.Rd b/man/mmkin.Rd index e871d78b..a763fcdf 100644 --- a/man/mmkin.Rd +++ b/man/mmkin.Rd @@ -1,51 +1,41 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/mmkin.R \name{mmkin} \alias{mmkin} -\title{ - Fit one or more kinetic models with one or more state variables to one or more datasets -} -\description{ - This function calls \code{\link{mkinfit}} on all combinations of models and datasets - specified in its first two arguments. -} +\title{Fit one or more kinetic models with one or more state variables to one or +more datasets} \usage{ -mmkin(models, datasets, - cores = round(detectCores()/2), cluster = NULL, ...) +mmkin(models = c("SFO", "FOMC", "DFOP"), datasets, + cores = round(detectCores()/2), cluster = NULL, ...) } \arguments{ - \item{models}{ - Either a character vector of shorthand names ("SFO", "FOMC", "DFOP", - "HS", "SFORB"), or an optionally named list of \code{\link{mkinmod}} - objects. - } - \item{datasets}{ - An optionally named list of datasets suitable as observed data for - \code{\link{mkinfit}}. - } - \item{cores}{ - The number of cores to be used for multicore processing. This is only - used when the \code{cluster} argument is \code{NULL}. On Windows machines, - cores > 1 is not supported, you need to use the \code{cluster} argument - to use multiple logical processors. - } - \item{cluster}{ - A cluster as returned by \code{\link{makeCluster}} to be used for parallel - execution. - } - \item{\dots}{ - Further arguments that will be passed to \code{\link{mkinfit}}. - } +\item{models}{Either a character vector of shorthand names like +\code{c("SFO", "FOMC", "DFOP", "HS", "SFORB")}, or an optionally named +list of \code{\link{mkinmod}} objects.} + +\item{datasets}{An optionally named list of datasets suitable as observed +data for \code{\link{mkinfit}}.} + +\item{cores}{The number of cores to be used for multicore processing. This +is only used when the \code{cluster} argument is \code{NULL}. On Windows +machines, cores > 1 is not supported, you need to use the \code{cluster} +argument to use multiple logical processors.} + +\item{cluster}{A cluster as returned by \code{\link{makeCluster}} to be used +for parallel execution.} + +\item{\dots}{Further arguments that will be passed to \code{\link{mkinfit}}.} } \value{ - A matrix of \code{\link{mkinfit}} objects that can be indexed using the model - and dataset names as row and column indices. -} -\seealso{ - \code{\link{[.mmkin}} for subsetting, \code{\link{plot.mmkin}} for plotting. +A matrix of \code{\link{mkinfit}} objects that can be indexed using + the model and dataset names as row and column indices. } -\author{ - Johannes Ranke +\description{ +This function calls \code{\link{mkinfit}} on all combinations of models and +datasets specified in its first two arguments. } \examples{ + \dontrun{ m_synth_SFO_lin <- mkinmod(parent = mkinsub("SFO", "M1"), M1 = mkinsub("SFO", "M2"), @@ -79,5 +69,13 @@ plot_sep(fits.0[[1, 1]]) # allow to plot the observed variables separately plot(fits.0[1, 1]) } + +} +\seealso{ +\code{\link{[.mmkin}} for subsetting, \code{\link{plot.mmkin}} for + plotting. +} +\author{ +Johannes Ranke } -\keyword{ optimize } +\keyword{optimize} |