diff options
Diffstat (limited to 'docs/reference/mkinsub.html')
| -rw-r--r-- | docs/reference/mkinsub.html | 60 |
1 files changed, 32 insertions, 28 deletions
diff --git a/docs/reference/mkinsub.html b/docs/reference/mkinsub.html index aff0b593..2269b228 100644 --- a/docs/reference/mkinsub.html +++ b/docs/reference/mkinsub.html @@ -6,8 +6,7 @@ <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>Function to set up a kinetic submodel for one state variable — mkinsub • mkin</title> <!-- jquery --> <script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script> @@ -26,12 +25,14 @@ <script src="../pkgdown.js"></script> <!-- mathjax --> -<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> +<script src='https://mathjax.rstudio.com/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> @@ -71,6 +72,9 @@ <li> <a href="../articles/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a> </li> + <li> + <a href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a> + </li> </ul> </li> <li> @@ -96,8 +100,7 @@ <div class="row"> <div class="col-md-9 contents"> <div class="page-header"> - <h1> -</h1> + <h1>Function to set up a kinetic submodel for one state variable</h1> </div> @@ -105,33 +108,34 @@ <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> + <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> - <dl class="dl-horizontal"> - <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. + <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> + </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> + </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> + </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. - </dd> - </dl> + operating systems or system configurations.</p></td> + </tr> + </table> <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> |