diff options
Diffstat (limited to 'docs/reference/max_twa_parent.html')
| -rw-r--r-- | docs/reference/max_twa_parent.html | 65 |
1 files changed, 47 insertions, 18 deletions
diff --git a/docs/reference/max_twa_parent.html b/docs/reference/max_twa_parent.html index 69da881b..3c8e1662 100644 --- a/docs/reference/max_twa_parent.html +++ b/docs/reference/max_twa_parent.html @@ -23,7 +23,7 @@ soil section of the FOCUS guidance."><!-- mathjax --><script src="https://cdnjs. </button> <span class="navbar-brand"> <a class="navbar-link" href="../index.html">mkin</a> - <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1.0</span> + <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.2.0</span> </span> </div> @@ -50,19 +50,25 @@ soil section of the FOCUS guidance."><!-- mathjax --><script src="https://cdnjs. <a href="../articles/web_only/dimethenamid_2018.html">Example evaluations of dimethenamid data from 2018 with nonlinear mixed-effects models</a> </li> <li> - <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a> + <a href="../articles/web_only/multistart.html">Short demo of the multistart method</a> </li> <li> <a href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a> </li> <li> + <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a> + </li> + <li> <a href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a> </li> <li> <a href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a> </li> <li> - <a href="../articles/web_only/benchmarks.html">Some benchmark timings</a> + <a href="../articles/web_only/benchmarks.html">Benchmark timings for mkin</a> + </li> + <li> + <a href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a> </li> </ul></li> <li> @@ -98,49 +104,72 @@ soil section of the FOCUS guidance.</p> </div> <div id="ref-usage"> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">max_twa_parent</span><span class="op">(</span><span class="va">fit</span>, <span class="va">windows</span><span class="op">)</span> - -<span class="fu">max_twa_sfo</span><span class="op">(</span>M0 <span class="op">=</span> <span class="fl">1</span>, <span class="va">k</span>, <span class="va">t</span><span class="op">)</span> - -<span class="fu">max_twa_fomc</span><span class="op">(</span>M0 <span class="op">=</span> <span class="fl">1</span>, <span class="va">alpha</span>, <span class="va">beta</span>, <span class="va">t</span><span class="op">)</span> - -<span class="fu">max_twa_dfop</span><span class="op">(</span>M0 <span class="op">=</span> <span class="fl">1</span>, <span class="va">k1</span>, <span class="va">k2</span>, <span class="va">g</span>, <span class="va">t</span><span class="op">)</span> - -<span class="fu">max_twa_hs</span><span class="op">(</span>M0 <span class="op">=</span> <span class="fl">1</span>, <span class="va">k1</span>, <span class="va">k2</span>, <span class="va">tb</span>, <span class="va">t</span><span class="op">)</span></code></pre></div> + <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">max_twa_parent</span><span class="op">(</span><span class="va">fit</span>, <span class="va">windows</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">max_twa_sfo</span><span class="op">(</span>M0 <span class="op">=</span> <span class="fl">1</span>, <span class="va">k</span>, <span class="va">t</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">max_twa_fomc</span><span class="op">(</span>M0 <span class="op">=</span> <span class="fl">1</span>, <span class="va">alpha</span>, <span class="va">beta</span>, <span class="va">t</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">max_twa_dfop</span><span class="op">(</span>M0 <span class="op">=</span> <span class="fl">1</span>, <span class="va">k1</span>, <span class="va">k2</span>, <span class="va">g</span>, <span class="va">t</span><span class="op">)</span></span> +<span></span> +<span><span class="fu">max_twa_hs</span><span class="op">(</span>M0 <span class="op">=</span> <span class="fl">1</span>, <span class="va">k1</span>, <span class="va">k2</span>, <span class="va">tb</span>, <span class="va">t</span><span class="op">)</span></span></code></pre></div> </div> <div id="arguments"> <h2>Arguments</h2> <dl><dt>fit</dt> <dd><p>An object of class <code><a href="mkinfit.html">mkinfit</a></code>.</p></dd> + + <dt>windows</dt> <dd><p>The width of the time windows for which the TWAs should be calculated.</p></dd> + + <dt>M0</dt> <dd><p>The initial concentration for which the maximum time weighted average over the decline curve should be calculated. The default is to use a value of 1, which means that a relative maximum time weighted average factor (f_twa) is calculated.</p></dd> + + <dt>k</dt> <dd><p>The rate constant in the case of SFO kinetics.</p></dd> + + <dt>t</dt> <dd><p>The width of the time window.</p></dd> + + <dt>alpha</dt> <dd><p>Parameter of the FOMC model.</p></dd> + + <dt>beta</dt> <dd><p>Parameter of the FOMC model.</p></dd> + + <dt>k1</dt> <dd><p>The first rate constant of the DFOP or the HS kinetics.</p></dd> + + <dt>k2</dt> <dd><p>The second rate constant of the DFOP or the HS kinetics.</p></dd> + + <dt>g</dt> <dd><p>Parameter of the DFOP model.</p></dd> + + <dt>tb</dt> <dd><p>Parameter of the HS model.</p></dd> + </dl></div> <div id="value"> <h2>Value</h2> - <p>For <code>max_twa_parent</code>, a numeric vector, named using the + + +<p>For <code>max_twa_parent</code>, a numeric vector, named using the <code>windows</code> argument. For the other functions, a numeric vector of length one (also known as 'a number').</p> </div> @@ -159,12 +188,12 @@ EC Document Reference Sanco/10058/2005 version 2.0, 434 pp, <div id="ref-examples"> <h2>Examples</h2> - <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"></span> -<span class="r-in"> <span class="va">fit</span> <span class="op"><-</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="st">"FOMC"</span>, <span class="va">FOCUS_2006_C</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span> -<span class="r-in"> <span class="fu">max_twa_parent</span><span class="op">(</span><span class="va">fit</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">7</span>, <span class="fl">21</span><span class="op">)</span><span class="op">)</span></span> + <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span> +<span class="r-in"><span> <span class="va">fit</span> <span class="op"><-</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="st">"FOMC"</span>, <span class="va">FOCUS_2006_C</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span> +<span class="r-in"><span> <span class="fu">max_twa_parent</span><span class="op">(</span><span class="va">fit</span>, <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="fl">7</span>, <span class="fl">21</span><span class="op">)</span><span class="op">)</span></span></span> <span class="r-out co"><span class="r-pr">#></span> 7 21 </span> <span class="r-out co"><span class="r-pr">#></span> 34.71343 18.22124 </span> -<span class="r-in"></span> +<span class="r-in"><span></span></span> </code></pre></div> </div> </div> @@ -179,7 +208,7 @@ EC Document Reference Sanco/10058/2005 version 2.0, 434 pp, </div> <div class="pkgdown"> - <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p> + <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p> </div> </footer></div> |