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/mkinsub.html | 149 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 149 insertions(+) create mode 100644 inst/web/mkinsub.html (limited to 'inst/web/mkinsub.html') diff --git a/inst/web/mkinsub.html b/inst/web/mkinsub.html new file mode 100644 index 00000000..94e650ff --- /dev/null +++ b/inst/web/mkinsub.html @@ -0,0 +1,149 @@ + + + + +mkinsub. mkin 0.9-41 + + + + + + + + + + + + + + + +
+
+
+ mkin 0.9-41 +
+ +
+
+
+
+ +
+
+ +
+ +

+ Function to set up a kinetic submodel for one state variable +

+ +
+
+

Usage

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

Description

+ +

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

+ +
+ +
+

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 + + +
+
+ + +
+ + \ No newline at end of file -- cgit v1.2.1