From 3151647526f299686b68420a83ae38cd7f3d08f5 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Mon, 9 Nov 2015 09:05:15 +0100 Subject: Rebuild vignettes and static documentation --- inst/web/mmkin.html | 158 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 158 insertions(+) create mode 100644 inst/web/mmkin.html (limited to 'inst/web/mmkin.html') diff --git a/inst/web/mmkin.html b/inst/web/mmkin.html new file mode 100644 index 00000000..e09e6859 --- /dev/null +++ b/inst/web/mmkin.html @@ -0,0 +1,158 @@ + + + + +mmkin. mkin 0.9-41 + + + + + + + + + + + + + + + + + +
+
+ +
+ +

+ 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, ...)
+ +

Arguments

+
+
models
+
+ Either a character vector of shorthand names ("SFO", "FOMC", "DFOP", + "HS", "SFORB"), or an optionally named list of mkinmod + objects. +
+
datasets
+
+ An optionally named list of datasets suitable as observed data for + mkinfit. +
+
cores
+
+ The number of cores to be used for multicore processing. This is only + used when the cluster argument is NULL. +
+
cluster
+
+ A cluster as returned by makeCluster to be used for parallel + execution. +
+
...
+
+ Further arguments that will be passed to mkinfit. +
+
+ +
+

Description

+ +

This function calls mkinfit on all combinations of models and datasets + specified in its first two arguments.

+ +
+ +
+

Value

+ +

+ A matrix of mkinfit objects that can be indexed using the model + and dataset names as row and column indices. +

+ +
+ +

Examples

+
## Not run: +# m_synth_SFO_lin <- mkinmod(parent = list(type = "SFO", to = "M1"), +# M1 = list(type = "SFO", to = "M2"), +# M2 = list(type = "SFO"), use_of_ff = "max") +# +# m_synth_FOMC_lin <- mkinmod(parent = list(type = "FOMC", to = "M1"), +# M1 = list(type = "SFO", to = "M2"), +# M2 = list(type = "SFO"), use_of_ff = "max") +# +# models <- list(SFO_lin = m_synth_SFO_lin, FOMC_lin = m_synth_FOMC_lin) +# datasets <- lapply(synthetic_data_for_UBA_2014[1:3], function(x) x$data) +# +# time_default <- system.time(fits <- mmkin(models, datasets)) +# time_1 <- system.time(fits.1 <- mmkin(models, datasets, cores = 1)) +# +# time_default +# time_1 +# +# endpoints(fits[["SFO_lin", 2]]) +# ## End(Not run) +
+
+
+ + +

See also

+ + [.mmkin for subsetting, plot.mmkin for plotting. + + +

Author

+ + Johannes Ranke + + +
+
+ + +
+ + \ No newline at end of file -- cgit v1.2.1