From 2a521ab0a4b7d981a2042353e2c60b8a877489b8 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 16 Sep 2022 10:51:48 +0200 Subject: Improve docs and update pkgdown --- docs/dev/reference/multistart.html | 195 +++++++++++++++++++++++++++++++++++++ 1 file changed, 195 insertions(+) create mode 100644 docs/dev/reference/multistart.html (limited to 'docs/dev/reference/multistart.html') diff --git a/docs/dev/reference/multistart.html b/docs/dev/reference/multistart.html new file mode 100644 index 00000000..9f2d297e --- /dev/null +++ b/docs/dev/reference/multistart.html @@ -0,0 +1,195 @@ + +Perform a hierarchical model fit with multiple starting values — multistart • mkin + + +
+
+ + + +
+
+
+

Perform a hierarchical model fit with multiple starting values

+ Source: R/multistart.R + +
+ +
+

The purpose of this method is to check if a certain algorithm for fitting +nonlinear hierarchical models (also known as nonlinear mixed-effects models) +will reliably yield results that are sufficiently similar to each other, if +started with a certain range of reasonable starting parameters. It is +inspired by the article on practical identifiabiliy in the frame of nonlinear +mixed-effects models by Duchesne et al (2021).

+
+ +
+ 
multistart(object, n = 50, cores = 1, ...)
+
+# S3 method for saem.mmkin
+multistart(object, n = 50, cores = 1, ...)
+
+# S3 method for multistart
+print(x, ...)
+
+# S3 method for multistart
+parms(object, ...)
+
+parhist(object, lpos = "topleft", main = "", ...)
+
+llhist(object, breaks = "Sturges", lpos = "topleft", main = "", ...)
+
+ +
+

Arguments

+
object
+

The fit object to work with

+ + +
n
+

How many different combinations of starting parameters should be +used?

+ + +
cores
+

How many fits should be run in parallel?

+ + +
...
+

Passed to the update function, or to the basic plotting +function in the case of the graphical functions.

+ + +
x
+

The multistart object to print

+ + +
lpos
+

Positioning of the legend.

+ + +
main
+

title of the plot

+ + +
breaks
+

Passed to hist

+ +
+
+

Value

+ + +

A list of saem.mmkin objects, with class attributes +'multistart.saem.mmkin' and 'multistart'.

+
+
+

Details

+

Currently, parallel execution of the fits is only supported using +parallel::mclapply, i.e. not available on Windows.

+
+
+

References

+

Duchesne R, Guillemin A, Gandrillon O, Crauste F. Practical +identifiability in the frame of nonlinear mixed effects models: the example +of the in vitro erythropoiesis. BMC Bioinformatics. 2021 Oct 4;22(1):478. +doi: 10.1186/s12859-021-04373-4.

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