From a77a10ea6c607346778ba0700b3b66ac393101a2 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 27 May 2020 06:06:08 +0200 Subject: Create up to date pkgdown docs in development mode --- docs/dev/reference/mkinsub.html | 228 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 228 insertions(+) create mode 100644 docs/dev/reference/mkinsub.html (limited to 'docs/dev/reference/mkinsub.html') diff --git a/docs/dev/reference/mkinsub.html b/docs/dev/reference/mkinsub.html new file mode 100644 index 00000000..dc4faf0d --- /dev/null +++ b/docs/dev/reference/mkinsub.html @@ -0,0 +1,228 @@ + + + + + + + + +Function to set up a kinetic submodel for one state variable — mkinsub • mkin + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + + +
+ +
+
+
+

Function to set up a kinetic submodel for one state variable

+ Source: R/mkinsub.R + +
+ +
+

This is a convenience function to set up the lists used as arguments for +mkinmod.

+
+ + 
mkinsub(submodel, to = NULL, sink = TRUE, full_name = NA)
+ +

Arguments

+ + + + + + + + + + + + + + + + + + +
submodel

Character vector of length one to specify the submodel type. +See mkinmod for the list of allowed submodel names.

to

Vector of the names of the state variable to which a +transformation shall be included in the model.

sink

Should a pathway to sink be included in the model in addition to +the pathways to other state variables?

full_name

An optional name to be used e.g. for plotting fits +performed with the model. You can use non-ASCII characters here, but then +your R code will not be portable, i.e. may produce unintended plot +results on other operating systems or system configurations.

+ +

Value

+ +

A list for use with mkinmod.

+ +

Examples

+ 

+# One parent compound, one metabolite, both single first order.
+SFO_SFO <- mkinmod(
+  parent = list(type = "SFO", to = "m1"),
+  m1 = list(type = "SFO"))
#> Successfully compiled differential equation model from auto-generated C code.

+# The same model using mkinsub
+SFO_SFO.2 <- mkinmod(
+  parent = mkinsub("SFO", "m1"),
+  m1 = mkinsub("SFO"))
#> Successfully compiled differential equation model from auto-generated C code.

+# \dontrun{
+  # Now supplying full names
+  SFO_SFO.2 <- mkinmod(
+    parent = mkinsub("SFO", "m1", full_name = "Test compound"),
+    m1 = mkinsub("SFO", full_name = "Metabolite M1"))
#> Successfully compiled differential equation model from auto-generated C code.
 # }
+
+
+ +
+ + + +
+ + + + + + + + -- cgit v1.2.1