Static documentation rebuilt by pkgdown::build_site()

author: Johannes Ranke <jranke@uni-bremen.de> 2016-10-06 09:19:21 +0200
committer: Johannes Ranke <jranke@uni-bremen.de> 2016-10-06 09:19:21 +0200
commit: 38f9e15f0c972c1516ae737a2bca8d7789581bbd (patch)
tree: 724c9dc19901f24f427757ac81001f07bf298024 /docs/reference/mkinsub.html
parent: ec1487f0f2cef32d44b0c6ce94a6f1b4f65a79d3 (diff)
1 files changed, 147 insertions, 0 deletions
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 @@
+<!-- Generated by pkgdown: do not edit by hand -->
+<!DOCTYPE html>
+<html>
+  <head>
+  <meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+<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">
+
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+<!-- Font Awesome icons -->
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
+
+
+<!-- pkgdown -->
+<link href="../pkgdown.css" rel="stylesheet">
+<script src="../pkgdown.js"></script>
+
+<!-- mathjax -->
+<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script>
+
+<!--[if lt IE 9]>
+<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
+<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
+<![endif]-->
+  </head>
+
+  <body>
+    <div class="container">
+      <header>
+      
+<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">
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+        <span class="icon-bar"></span>
+      </button>
+      <a class="navbar-brand" href="../index.html">mkin</a>
+    </div>
+    <div id="navbar" class="navbar-collapse collapse">
+      <ul class="nav navbar-nav">
+        <li>
+  <a href="../index.html">Home</a>
+</li>
+<li>
+  <a href="../reference/index.html">Reference</a>
+</li>
+      </ul>
+      <ul class="nav navbar-nav navbar-right">
+        <li>
+  <a href="https://github.com/jranke/mkin">
+    <span class="fa fa-github fa-lg"></span>
+     
+  </a>
+</li>
+      </ul>
+    </div><!--/.nav-collapse -->
+  </div><!--/.container -->
+</div><!--/.navbar -->
+      
+      </header>
+
+      <div class="page-header">
+  <h1>
+</h1>
+</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>
+    
+
+    <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>
+    <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.
+  </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="Value">
+      <h2>Value</h2>
+
+      <p>A list for use with <code>mkinmod</code>.</p>
+    </div>
+    
+    <h2 id="examples">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='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='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='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">
+    <h2>Author</h2>
+    
+  Johannes Ranke
+
+  </div>
+</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>
+      </footer>
+   </div>
+
+  </body>
+</html>
author	Johannes Ranke <jranke@uni-bremen.de>	2016-10-06 09:19:21 +0200
committer	Johannes Ranke <jranke@uni-bremen.de>	2016-10-06 09:19:21 +0200
commit	38f9e15f0c972c1516ae737a2bca8d7789581bbd (patch)
tree	724c9dc19901f24f427757ac81001f07bf298024 /docs/reference/mkinsub.html
parent	ec1487f0f2cef32d44b0c6ce94a6f1b4f65a79d3 (diff)