aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/mkinsub.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2016-10-26 23:18:20 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2016-10-26 23:18:20 +0200
commit8f38147e145c66ebd27f5d9fcc6f00172c25872f (patch)
tree35123308ef781f6ad4b83b6d421d5e0e35d2e574 /docs/reference/mkinsub.html
parentd106bebafe070cb803dd7205b1581b20eaf61cb5 (diff)
Static documentation rebuilt by pkgdown::build_site()
Diffstat (limited to 'docs/reference/mkinsub.html')
-rw-r--r--docs/reference/mkinsub.html68
1 files changed, 44 insertions, 24 deletions
diff --git a/docs/reference/mkinsub.html b/docs/reference/mkinsub.html
index 6b079c40..2432e981 100644
--- a/docs/reference/mkinsub.html
+++ b/docs/reference/mkinsub.html
@@ -6,14 +6,14 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>mkinsub. mkin</title>
+<title>
+ — mkinsub • mkin</title>
<!-- jquery -->
<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
-
<!-- Bootstrap -->
-<link href="https://maxcdn.bootstrapcdn.com/bootswatch/3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" crossorigin="anonymous">
+<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
@@ -22,6 +22,7 @@
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
+<script src="../jquery.sticky-kit.min.js"></script>
<script src="../pkgdown.js"></script>
<!-- mathjax -->
@@ -34,10 +35,9 @@
</head>
<body>
- <div class="container">
+ <div class="container template-reference-topic">
<header>
-
-<div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
@@ -56,6 +56,7 @@
<a href="../reference/index.html">Reference</a>
</li>
</ul>
+
<ul class="nav navbar-nav navbar-right">
<li>
<a href="https://github.com/jranke/mkin">
@@ -67,29 +68,30 @@
</div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
+
</header>
- <div class="page-header">
- <h1>
+ <div class="row">
+ <div class="col-md-9 contents">
+ <div class="page-header">
+ <h1>
</h1>
-</div>
+ </div>
-<div class="row">
- <div class="col-md-9">
<p>This is a convenience function to set up the lists used as arguments for
- <code>mkinmod</code>.</p>
+ <code><a href='mkinmod.html'>mkinmod</a></code>.</p>
<pre><span class='fu'>mkinsub</span>(<span class='no'>submodel</span>, <span class='kw'>to</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>sink</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>full_name</span> <span class='kw'>=</span> <span class='fl'>NA</span>)</pre>
- <h2>Arguments</h2>
+ <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2>
<dl class="dl-horizontal">
<dt>submodel</dt>
<dd>
Character vector of length one to specify the submodel type. See
- <code>mkinmod</code> for the list of allowed submodel names.
+ <code><a href='mkinmod.html'>mkinmod</a></code> for the list of allowed submodel names.
</dd>
<dt>to</dt>
<dd>
@@ -110,27 +112,38 @@
</dd>
</dl>
- <div class="Value">
- <h2>Value</h2>
+ <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
- <p>A list for use with <code>mkinmod</code>.</p>
- </div>
+ <p>A list for use with <code><a href='mkinmod.html'>mkinmod</a></code>.</p>
- <h2 id="examples">Examples</h2>
+
+ <h2 class="hasAnchor" id="examples">
+ <a class="anchor" href="#examples"></a>
+ Examples
+ </h2>
<pre class="examples"><div class='input'><span class='co'># One parent compound, one metabolite, both single first order.</span>
-<span class='no'>SFO_SFO</span> <span class='kw'>&lt;-</span> <span class='fu'>mkinmod</span>(
+<span class='no'>SFO_SFO</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(
<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'>list</span>(<span class='kw'>type</span> <span class='kw'>=</span> <span class='st'>"SFO"</span>, <span class='kw'>to</span> <span class='kw'>=</span> <span class='st'>"m1"</span>),
<span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'>list</span>(<span class='kw'>type</span> <span class='kw'>=</span> <span class='st'>"SFO"</span>))</div><div class='output'><strong class='text-info'>Successfully compiled differential equation model from auto-generated C code.</strong></div><div class='input'>
<span class='co'># The same model using mkinsub</span>
-<span class='no'>SFO_SFO.2</span> <span class='kw'>&lt;-</span> <span class='fu'>mkinmod</span>(
+<span class='no'>SFO_SFO.2</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(
<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'>mkinsub</span>(<span class='st'>"SFO"</span>, <span class='st'>"m1"</span>),
<span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'>mkinsub</span>(<span class='st'>"SFO"</span>))</div><div class='output'><strong class='text-info'>Successfully compiled differential equation model from auto-generated C code.</strong></div><div class='input'>
<span class='co'># Now supplying full names</span>
-<span class='no'>SFO_SFO.2</span> <span class='kw'>&lt;-</span> <span class='fu'>mkinmod</span>(
+<span class='no'>SFO_SFO.2</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(
<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'>mkinsub</span>(<span class='st'>"SFO"</span>, <span class='st'>"m1"</span>, <span class='kw'>full_name</span> <span class='kw'>=</span> <span class='st'>"Test compound"</span>),
<span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'>mkinsub</span>(<span class='st'>"SFO"</span>, <span class='kw'>full_name</span> <span class='kw'>=</span> <span class='st'>"Metabolite M1"</span>))</div><div class='output'><strong class='text-info'>Successfully compiled differential equation model from auto-generated C code.</strong></div></pre>
</div>
- <div class="col-md-3">
+ <div class="col-md-3 hidden-xs hidden-sm" id="sidebar">
+ <h2>Contents</h2>
+ <ul class="nav nav-pills nav-stacked">
+ <li><a href="#arguments">Arguments</a></li>
+
+ <li><a href="#value">Value</a></li>
+
+ <li><a href="#examples">Examples</a></li>
+ </ul>
+
<h2>Author</h2>
Johannes Ranke
@@ -139,7 +152,14 @@
</div>
<footer>
- <p>Built by <a href="http://hadley.github.io/pkgdown/">pkgdown</a>. Styled with <a href="http://getbootstrap.com">Bootstrap 3</a>.</p>
+ <div class="copyright">
+ <p>Developed by Johannes Ranke, Eurofins Regulatory AG.</p>
+</div>
+
+<div class="pkgdown">
+ <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+</div>
+
</footer>
</div>

Contact - Imprint