diff options
author | Johannes Ranke <jranke@uni-bremen.de> | 2019-10-25 02:10:08 +0200 |
---|---|---|
committer | Johannes Ranke <jranke@uni-bremen.de> | 2019-10-25 02:10:08 +0200 |
commit | af2e1540cdad2fd00bb6216a38a754ff748629ad (patch) | |
tree | 9ec5d1ff3050c9fa826636536fc60dbda9edb1e4 /docs/reference/mkinsub.html | |
parent | 0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 (diff) |
Static documentation rebuilt by pkgdown
Diffstat (limited to 'docs/reference/mkinsub.html')
-rw-r--r-- | docs/reference/mkinsub.html | 45 |
1 files changed, 22 insertions, 23 deletions
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 @@ <title>Function to set up a kinetic submodel for one state variable — mkinsub • mkin</title> + <!-- jquery --> <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script> <!-- Bootstrap --> <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" /> + <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script> <!-- Font Awesome icons --> @@ -32,14 +34,15 @@ -<meta property="og:title" content="Function to set up a kinetic submodel for one state variable — mkinsub" /> +<meta property="og:title" content="Function to set up a kinetic submodel for one state variable — mkinsub" /> <meta property="og:description" content="This is a convenience function to set up the lists used as arguments for - mkinmod." /> +mkinmod." /> <meta name="twitter:card" content="summary" /> + <!-- mathjax --> <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script> <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script> @@ -110,7 +113,6 @@ <a href="../news/index.html">News</a> </li> </ul> - <ul class="nav navbar-nav navbar-right"> </ul> @@ -132,48 +134,46 @@ </div> <div class="ref-description"> - <p>This is a convenience function to set up the lists used as arguments for - <code><a href='mkinmod.html'>mkinmod</a></code>.</p> - +<code><a href='mkinmod.html'>mkinmod</a></code>.</p> </div> <pre class="usage"><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 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2> <table class="ref-arguments"> <colgroup><col class="name" /><col class="desc" /></colgroup> <tr> <th>submodel</th> - <td><p>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.</p></td> + <td><p>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.</p></td> </tr> <tr> <th>to</th> - <td><p>Vector of the names of the state variable to which a transformation - shall be included in the model.</p></td> + <td><p>Vector of the names of the state variable to which a +transformation shall be included in the model.</p></td> </tr> <tr> <th>sink</th> - <td><p>Should a pathway to sink be included in the model in addition to the - pathways to other state variables?</p></td> + <td><p>Should a pathway to sink be included in the model in addition to +the pathways to other state variables?</p></td> </tr> <tr> <th>full_name</th> - <td><p>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.</p></td> + <td><p>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.</p></td> </tr> </table> - + <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> <p>A list for use with <code><a href='mkinmod.html'>mkinmod</a></code>.</p> - <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> + <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'><-</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>( <span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/list.html'>list</a></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'><a href='https://rdrr.io/r/base/list.html'>list</a></span>(<span class='kw'>type</span> <span class='kw'>=</span> <span class='st'>"SFO"</span>))</div><div class='output co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'> @@ -184,15 +184,14 @@ <span class='co'># Now supplying full names</span> <span class='no'>SFO_SFO.2</span> <span class='kw'><-</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 co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div></pre> + <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 co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'> +</div></pre> </div> <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> |