aboutsummaryrefslogblamecommitdiff
path: root/inst/web/mkinsub.html
blob: 1c7ca30ad3d53b351ff68b68e2e42d3fafc1bf28 (plain) (tree)
1
2
3
4
5



                          
                                        






























                                                                                      
                                                    















































































































                                                                                                                                                       
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
<title>mkinsub. mkin 0.9.43.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.43.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&nbsp;=&nbsp;NULL, sink&nbsp;=&nbsp;TRUE, full_name&nbsp;=&nbsp;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 &lt;- mkinmod(
  parent = list(type = &quot;SFO&quot;, to = &quot;m1&quot;),
  m1 = list(type = &quot;SFO&quot;))
</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 &lt;- mkinmod(
  parent = mkinsub(&quot;SFO&quot;, &quot;m1&quot;),
  m1 = mkinsub(&quot;SFO&quot;))
</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 &lt;- mkinmod(
  parent = mkinsub(&quot;SFO&quot;, &quot;m1&quot;, full_name = &quot;Test compound&quot;),
  m1 = mkinsub(&quot;SFO&quot;, full_name = &quot;Metabolite M1&quot;))
</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>

Contact - Imprint