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/mkinsub.html | 147 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) create mode 100644 docs/reference/mkinsub.html (limited to 'docs/reference/mkinsub.html') diff --git a/docs/reference/mkinsub.html b/docs/reference/mkinsub.html new file mode 100644 index 00000000..6b079c40 --- /dev/null +++ b/docs/reference/mkinsub.html @@ -0,0 +1,147 @@ + + + + + + + + +mkinsub. mkin + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+

+

+
+ +
+
+ +

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.

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

Author

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