aboutsummaryrefslogblamecommitdiff
path: root/man/mhmkin.Rd
blob: 0ef1599e41d3482336316d045c1da38aa1403f51 (plain) (tree) 
9e346fab











































































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75











































































                                                                                                            
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/mhmkin.R
\name{mhmkin}
\alias{mhmkin}
\alias{mhmkin.list}
\alias{[.mhmkin}
\alias{print.mhmkin}
\title{Fit nonlinear mixed-effects models built from one or more kinetic
degradation models and one or more error models}
\usage{
mhmkin(objects, backend = "saemix", algorithm = "saem", ...)

\method{mhmkin}{list}(
  objects,
  backend = "saemix",
  ...,
  cores = if (Sys.info()["sysname"] == "Windows") 1 else parallel::detectCores(),
  cluster = NULL
)

\method{[}{mhmkin}(x, i, j, ..., drop = FALSE)

\method{print}{mhmkin}(x, ...)
}
\arguments{
\item{objects}{A list of \link{mmkin} objects containing fits of the same
degradation models to the same data, but using different error models.}

\item{backend}{The backend to be used for fitting. Currently, only saemix is
supported}

\item{algorithm}{The algorithm to be used for fitting (currently not used)}

\item{\dots}{Further arguments that will be passed to the nonlinear mixed-effects
model fitting function.}

\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. Per default, all cores detected
by \code{\link[parallel:detectCores]{parallel::detectCores()}} are used, except on Windows where the default
is 1.}

\item{cluster}{A cluster as returned by \link{makeCluster} to be used for
parallel execution.}

\item{x}{An \link{mhmkin} object.}

\item{i}{Row index selecting the fits for specific models}

\item{j}{Column index selecting the fits to specific datasets}

\item{drop}{If FALSE, the method always returns an mhmkin object, otherwise
either a list of fit objects or a single fit object.}
}
\value{
A two-dimensional \link{array} of fit objects and/or try-errors that can
be indexed using the degradation model names for the first index (row index)
and the error model names for the second index (column index), with class
attribute 'mhmkin'.

An object of class \code{\link{mhmkin}}.
}
\description{
The name of the methods expresses that (\strong{m}ultiple) \strong{h}ierarchichal
(also known as multilevel) \strong{m}ulticompartment \strong{kin}etic models are
fitted. Our kinetic models are nonlinear, so we can use various nonlinear
mixed-effects model fitting functions.
}
\seealso{
\code{\link{[.mhmkin}} for subsetting \link{mhmkin} objects
}
\author{
Johannes Ranke
}

Contact - Imprint