From 6178249bbb5e9de7cb7f34287ee7de28a68fed6c Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 10 Aug 2022 15:38:17 +0200 Subject: Change dev branch used for docs, update static docs --- docs/dev/reference/mhmkin.html | 213 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 213 insertions(+) create mode 100644 docs/dev/reference/mhmkin.html (limited to 'docs/dev/reference/mhmkin.html') diff --git a/docs/dev/reference/mhmkin.html b/docs/dev/reference/mhmkin.html new file mode 100644 index 00000000..e77aace3 --- /dev/null +++ b/docs/dev/reference/mhmkin.html @@ -0,0 +1,213 @@ + +Fit nonlinear mixed-effects models built from one or more kinetic +degradation models and one or more error models — mhmkin • mkin + + +
+
+ + + +
+
+
+

Fit nonlinear mixed-effects models built from one or more kinetic +degradation models and one or more error models

+ Source: R/mhmkin.R + +
+ +
+

The name of the methods expresses that (multiple) hierarchichal +(also known as multilevel) multicompartment kinetic models are +fitted. Our kinetic models are nonlinear, so we can use various nonlinear +mixed-effects model fitting functions.

+
+ +
+ 
mhmkin(objects, backend = "saemix", algorithm = "saem", ...)
+
+# S3 method for list
+mhmkin(
+  objects,
+  backend = "saemix",
+  ...,
+  cores = if (Sys.info()["sysname"] == "Windows") 1 else parallel::detectCores(),
+  cluster = NULL
+)
+
+# S3 method for mhmkin
+[(x, i, j, ..., drop = FALSE)
+
+# S3 method for mhmkin
+print(x, ...)
+
+ +
+

Arguments

+
objects
+

A list of mmkin objects containing fits of the same +degradation models to the same data, but using different error models.

+ + +
backend
+

The backend to be used for fitting. Currently, only saemix is +supported

+ + +
algorithm
+

The algorithm to be used for fitting (currently not used)

+ + +
...
+

Further arguments that will be passed to the nonlinear mixed-effects +model fitting function.

+ + +
cores
+

The number of cores to be used for multicore processing. This +is only used when the cluster argument is NULL. On Windows +machines, cores > 1 is not supported, you need to use the cluster +argument to use multiple logical processors. Per default, all cores detected +by parallel::detectCores() are used, except on Windows where the default +is 1.

+ + +
cluster
+

A cluster as returned by makeCluster to be used for +parallel execution.

+ + +
x
+

An mhmkin object.

+ + +
i
+

Row index selecting the fits for specific models

+ + +
j
+

Column index selecting the fits to specific datasets

+ + +
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 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 mhmkin.

+
+
+

See also

+

[.mhmkin for subsetting mhmkin objects

+
+
+

Author

+

Johannes Ranke

+
+ +
+ +
+ + +
+ + + + + + + + -- cgit v1.2.1