From af2e1540cdad2fd00bb6216a38a754ff748629ad Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 25 Oct 2019 02:10:08 +0200 Subject: Static documentation rebuilt by pkgdown --- docs/reference/mmkin.html | 73 ++++++++++++++++++++++++----------------------- 1 file changed, 37 insertions(+), 36 deletions(-) (limited to 'docs/reference/mmkin.html') diff --git a/docs/reference/mmkin.html b/docs/reference/mmkin.html index 0f384062..8312c17c 100644 --- a/docs/reference/mmkin.html +++ b/docs/reference/mmkin.html @@ -6,13 +6,16 @@ -Fit one or more kinetic models with one or more state variables to one or more datasets — mmkin • mkin +Fit one or more kinetic models with one or more state variables to one or +more datasets — mmkin • mkin + + @@ -32,14 +35,16 @@ - - + + + @@ -110,7 +115,6 @@ News - @@ -126,65 +130,64 @@
-

Fit one or more kinetic models with one or more state variables to one or more datasets

+

Fit one or more kinetic models with one or more state variables to one or +more datasets

- -

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

- +

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

- 
mmkin(models, datasets,
-      cores = round(detectCores()/2), cluster = NULL, ...)
- + 
mmkin(models = c("SFO", "FOMC", "DFOP"), 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.

Either a character vector of shorthand names like +c("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.

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. On Windows machines, - cores > 1 is not supported, you need to use the cluster argument - to use multiple logical processors.

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.
cluster

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

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

Further arguments that will be passed to mkinfit.
- +

Value

-

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

- +

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

See also

-

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

- +

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

Examples

- 
# \dontrun{
+    

+# \dontrun{
 m_synth_SFO_lin <- mkinmod(parent = mkinsub("SFO", "M1"),
                            M1 = mkinsub("SFO", "M2"),
                            M2 = mkinsub("SFO"), use_of_ff = "max")
#> Successfully compiled differential equation model from auto-generated C code.

@@ -199,8 +202,8 @@
 time_1 <- system.time(fits.4 <- mmkin(models, datasets, cores = 1, quiet = TRUE))
 
 time_default
#>        User      System verstrichen 
-#>       0.016       0.029       4.960 
time_1
#>        User      System verstrichen 
-#>      19.084       0.004      19.099 

+#>       0.011       0.032       4.774 
time_1
#>        User      System verstrichen 
+#>      18.676       0.000      18.687 

 endpoints(fits.0[["SFO_lin", 2]])
#> $ff
 #>   parent_M1 parent_sink       M1_M2     M1_sink 
 #>   0.7340481   0.2659519   0.7505684   0.2494316 
@@ -221,17 +224,15 @@
 # Plotting with mmkin (single brackets, extracting an mmkin object) does not
 # allow to plot the observed variables separately
 plot(fits.0[1, 1])
# }
+