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/mkinsub.html | 45 ++++++++++++++++++++++----------------------- 1 file changed, 22 insertions(+), 23 deletions(-) (limited to 'docs/reference/mkinsub.html') diff --git a/docs/reference/mkinsub.html b/docs/reference/mkinsub.html index 1523138c..e38c153c 100644 --- a/docs/reference/mkinsub.html +++ b/docs/reference/mkinsub.html @@ -8,11 +8,13 @@ Function to set up a kinetic submodel for one state variable — mkinsub • mkin + + @@ -32,14 +34,15 @@ - + +mkinmod." /> + @@ -110,7 +113,6 @@ News - @@ -132,48 +134,46 @@
-

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

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

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.

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?

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.

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

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

@@ -184,15 +184,14 @@
 # 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.

+  m1 = mkinsub("SFO", full_name = "Metabolite M1"))
#> Successfully compiled differential equation model from auto-generated C code.

+