1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
|
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>mkinsub. mkin 0.9.44.9000</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="
Johannes Ranke
">
<link href="css/bootstrap.css" rel="stylesheet">
<link href="css/bootstrap-responsive.css" rel="stylesheet">
<link href="css/highlight.css" rel="stylesheet">
<link href="css/staticdocs.css" rel="stylesheet">
<!--[if lt IE 9]>
<script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
tex2jax: {
inlineMath: [ ['$','$'], ["\\(","\\)"] ],
processEscapes: true
}
});
</script>
<script type="text/javascript"
src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
</head>
<body>
<div class="navbar">
<div class="navbar-inner">
<div class="container">
<a class="brand" href="#">mkin 0.9.44.9000</a>
<div class="nav">
<ul class="nav">
<li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>
</ul>
</div>
</div>
</div>
</div>
<div class="container">
<header>
</header>
<h1>
Function to set up a kinetic submodel for one state variable
</h1>
<div class="row">
<div class="span8">
<h2>Usage</h2>
<pre><div>mkinsub(submodel, to = NULL, sink = TRUE, full_name = NA)</div></pre>
<h2>Arguments</h2>
<dl>
<dt>submodel</dt>
<dd>
Character vector of length one to specify the submodel type. See
<code><a href='mkinmod.html'>mkinmod</a></code> for the list of allowed submodel names.
</dd>
<dt>to</dt>
<dd>
Vector of the names of the state variable to which a transformation
shall be included in the model.
</dd>
<dt>sink</dt>
<dd>
Should a pathway to sink be included in the model in addition to the
pathways to other state variables?
</dd>
<dt>full_name</dt>
<dd>
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, <em>i.e.</em> may produce unintended plot results on other
operating systems or system configurations.
</dd>
</dl>
<div class="Description">
<h2>Description</h2>
<p>This is a convenience function to set up the lists used as arguments for
<code><a href='mkinmod.html'>mkinmod</a></code>.</p>
</div>
<div class="Value">
<h2>Value</h2>
<p><dl>
A list for use with <code><a href='mkinmod.html'>mkinmod</a></code>.
</dl></p>
</div>
<h2 id="examples">Examples</h2>
<pre class="examples"><div class='input'># One parent compound, one metabolite, both single first order.
SFO_SFO <- mkinmod(
parent = list(type = "SFO", to = "m1"),
m1 = list(type = "SFO"))
</div>
<strong class='message'>Successfully compiled differential equation model from auto-generated C code.</strong>
<div class='input'>
# The same model using mkinsub
SFO_SFO.2 <- mkinmod(
parent = mkinsub("SFO", "m1"),
m1 = mkinsub("SFO"))
</div>
<strong class='message'>Successfully compiled differential equation model from auto-generated C code.</strong>
<div class='input'>
# Now supplying full names
SFO_SFO.2 <- mkinmod(
parent = mkinsub("SFO", "m1", full_name = "Test compound"),
m1 = mkinsub("SFO", full_name = "Metabolite M1"))
</div>
<strong class='message'>Successfully compiled differential equation model from auto-generated C code.</strong></pre>
</div>
<div class="span4">
<!-- <ul>
<li>mkinsub</li>
</ul>
<ul>
</ul> -->
<h2>Author</h2>
Johannes Ranke
</div>
</div>
<footer>
<p class="pull-right"><a href="#">Back to top</a></p>
<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="http://twitter.github.com/bootstrap">bootstrap</a>.</p>
</footer>
</div>
</body>
</html>
|
