From 38f9e15f0c972c1516ae737a2bca8d7789581bbd Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 6 Oct 2016 09:19:21 +0200 Subject: Static documentation rebuilt by pkgdown::build_site() --- docs/reference/mmkin.html | 178 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 178 insertions(+) create mode 100644 docs/reference/mmkin.html (limited to 'docs/reference/mmkin.html') diff --git a/docs/reference/mmkin.html b/docs/reference/mmkin.html new file mode 100644 index 00000000..5b624893 --- /dev/null +++ b/docs/reference/mmkin.html @@ -0,0 +1,178 @@ + + + + + + + + +mmkin. mkin + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+

+

+
+ +
+
+ +

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

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

Value

+ +

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.

+
+ +

Examples

+ 
## Not run: ------------------------------------
+# m_synth_SFO_lin <- mkinmod(parent = mkinsub("SFO", "M1"),
+#                            M1 = mkinsub("SFO", "M2"),
+#                            M2 = mkinsub("SFO"), use_of_ff = "max")
+# 
+# m_synth_FOMC_lin <- mkinmod(parent = mkinsub("FOMC", "M1"),
+#                             M1 = mkinsub("SFO", "M2"),
+#                             M2 = mkinsub("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)
+# names(datasets) <- paste("Dataset", 1:3)
+# 
+# time_default <- system.time(fits.0 <- mmkin(models, datasets))
+# time_1 <- system.time(fits.1 <- mmkin(models, datasets, cores = 1))
+# 
+# time_default
+# time_1
+# 
+# endpoints(fits[["SFO_lin", 2]])
+# 
+# # Plot.mkinfit handles rows or columns of mmkin result objects
+# plot(fits.0[1, ])
+# plot(fits.0[1, ], obs_var = c("M1", "M2"))
+# plot(fits.0[, 1])
+# # Use double brackets to extract a single mkinfit object, which will be plotted
+# # by plot.mkinfit
+# plot(fits.0[[1, 1]], sep_obs = TRUE, show_residuals = TRUE, show_errmin = TRUE)
+# # Plotting with mmkin (single brackets, extracting an mmkin object) does not
+# # allow to plot the observed variables separately
+# plot(fits.0[1, 1])
+## ---------------------------------------------
+
+
+

Author

+ + Johannes Ranke + +
+
+ + +
+ + + -- cgit v1.2.1