diff options
Diffstat (limited to 'docs/reference/mkinmod.html')
| -rw-r--r-- | docs/reference/mkinmod.html | 86 |
1 files changed, 53 insertions, 33 deletions
diff --git a/docs/reference/mkinmod.html b/docs/reference/mkinmod.html index 9dd8fca0..53c87e92 100644 --- a/docs/reference/mkinmod.html +++ b/docs/reference/mkinmod.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>mkinmod. mkin</title> +<title> + — mkinmod • 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,16 +68,17 @@ </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>The function usually takes several expressions, each assigning a compound name to a list, specifying the kinetic model type and reaction or transfer to other @@ -89,7 +91,7 @@ <pre><span class='fu'>mkinmod</span>(<span class='no'>...</span>, <span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"min"</span>, <span class='kw'>speclist</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>verbose</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre> - <h2>Arguments</h2> + <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2> <dl class="dl-horizontal"> <dt>...</dt> <dd> @@ -131,41 +133,39 @@ </dd> </dl> - <div class="Value"> - <h2>Value</h2> + <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> - <p>A list of class <code>mkinmod</code> for use with <code>mkinfit</code>, containing</p> - </div> - - <div class="Note"> - <h2>Note</h2> + <p>A list of class <code>mkinmod</code> for use with <code><a href='mkinfit.html'>mkinfit</a></code>, containing</p> + + <h2 class="hasAnchor" id="note"><a class="anchor" href="#note"></a>Note</h2> - <p>The IORE submodel is not well tested (yet). When using this model for metabolites, + <p>The IORE submodel is not well tested (yet). When using this model for metabolites, you may want to read the second note in the help page to - <code>mkinfit</code>.</p> - </div> - - <div class="References"> - <h2>References</h2> + <code><a href='mkinfit.html'>mkinfit</a></code>.</p> + + <h2 class="hasAnchor" id="references"><a class="anchor" href="#references"></a>References</h2> - <p>FOCUS (2006) “Guidance Document on Estimating Persistence and + <p>FOCUS (2006) “Guidance Document on Estimating Persistence and Degradation Kinetics from Environmental Fate Studies on Pesticides in EU Registration” Report of the FOCUS Work Group on Degradation Kinetics, EC Document Reference Sanco/10058/2005 version 2.0, 434 pp, <a href = 'http://focus.jrc.ec.europa.eu/dk'>http://focus.jrc.ec.europa.eu/dk</a></p> - <p>NAFTA Technical Working Group on Pesticides (not dated) Guidance for + <p>NAFTA Technical Working Group on Pesticides (not dated) Guidance for Evaluating and Calculating Degradation Kinetics in Environmental Media</p> - </div> - <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'># Specify the SFO model (this is not needed any more, as we can now mkinfit("SFO", ...)</span> <span class='no'>SFO</span> <span class='kw'><-</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='co'># One parent compound, one metabolite, both single first order</span> <span class='no'>SFO_SFO</span> <span class='kw'><-</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='kw'>parent</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>, <span class='st'>"m1"</span>), + <span class='kw'>m1</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></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'>## Not run: ------------------------------------</span> <span class='co'># # The above model used to be specified like this, before the advent of mkinsub()</span> <span class='co'># SFO_SFO <- mkinmod(</span> @@ -189,7 +189,20 @@ <span class='co'># quiet = TRUE)</span> <span class='co'>## ---------------------------------------------</span></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="#note">Note</a></li> + + <li><a href="#references">References</a></li> + + <li><a href="#examples">Examples</a></li> + </ul> + <h2>Author</h2> Johannes Ranke @@ -198,7 +211,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> |