aboutsummaryrefslogtreecommitdiff
path: root/docs/dev/reference/nafta.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/reference/nafta.html')
-rw-r--r--docs/dev/reference/nafta.html215
1 files changed, 215 insertions, 0 deletions
diff --git a/docs/dev/reference/nafta.html b/docs/dev/reference/nafta.html
new file mode 100644
index 00000000..f7b018e5
--- /dev/null
+++ b/docs/dev/reference/nafta.html
@@ -0,0 +1,215 @@
+<!DOCTYPE html>
+<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Evaluate parent kinetics using the NAFTA guidance — nafta • mkin</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Evaluate parent kinetics using the NAFTA guidance — nafta"><meta name="description" content="The function fits the SFO, IORE and DFOP models using mmkin
+and returns an object of class nafta that has methods for printing
+and plotting.
+Print nafta objects. The results for the three models are printed in the
+order of increasing model complexity, i.e. SFO, then IORE, and finally DFOP."><meta property="og:description" content="The function fits the SFO, IORE and DFOP models using mmkin
+and returns an object of class nafta that has methods for printing
+and plotting.
+Print nafta objects. The results for the three models are printed in the
+order of increasing model complexity, i.e. SFO, then IORE, and finally DFOP."><meta name="robots" content="noindex"></head><body>
+ <a href="#main" class="visually-hidden-focusable">Skip to contents</a>
+
+
+ <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="default" aria-label="Site navigation"><div class="container">
+
+ <a class="navbar-brand me-2" href="../index.html">mkin</a>
+
+ <small class="nav-text text-info me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="In-development version">1.2.10</small>
+
+
+ <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
+ <span class="navbar-toggler-icon"></span>
+ </button>
+
+ <div id="navbar" class="collapse navbar-collapse ms-3">
+ <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
+<li class="nav-item dropdown">
+ <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
+ <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/mkin.html">Introduction to mkin</a></li>
+ <li><hr class="dropdown-divider"></li>
+ <li><h6 class="dropdown-header" data-toc-skip>Example evaluations with (generalised) nonlinear least squares</h6></li>
+ <li><a class="dropdown-item" href="../articles/FOCUS_D.html">Example evaluation of FOCUS Example Dataset D</a></li>
+ <li><a class="dropdown-item" href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a></li>
+ <li><a class="dropdown-item" href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a></li>
+ <li><hr class="dropdown-divider"></li>
+ <li><h6 class="dropdown-header" data-toc-skip>Example evaluations with hierarchical models (nonlinear mixed-effects models)</h6></li>
+ <li><a class="dropdown-item" href="../articles/prebuilt/2022_dmta_parent.html">Testing hierarchical parent degradation kinetics with residue data on dimethenamid and dimethenamid-P</a></li>
+ <li><a class="dropdown-item" href="../articles/prebuilt/2022_dmta_pathway.html">Testing hierarchical pathway kinetics with residue data on dimethenamid and dimethenamid-P</a></li>
+ <li><a class="dropdown-item" href="../articles/prebuilt/2023_mesotrione_parent.html">Testing covariate modelling in hierarchical parent degradation kinetics with residue data on mesotrione</a></li>
+ <li><a class="dropdown-item" href="../articles/prebuilt/2022_cyan_pathway.html">Testing hierarchical pathway kinetics with residue data on cyantraniliprole</a></li>
+ <li><a class="dropdown-item" href="../articles/web_only/dimethenamid_2018.html">Comparison of saemix and nlme evaluations of dimethenamid data from 2018</a></li>
+ <li><a class="dropdown-item" href="../articles/web_only/multistart.html">Short demo of the multistart method</a></li>
+ <li><hr class="dropdown-divider"></li>
+ <li><h6 class="dropdown-header" data-toc-skip>Performance</h6></li>
+ <li><a class="dropdown-item" href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a></li>
+ <li><a class="dropdown-item" href="../articles/web_only/benchmarks.html">Benchmark timings for mkin</a></li>
+ <li><a class="dropdown-item" href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a></li>
+ <li><hr class="dropdown-divider"></li>
+ <li><h6 class="dropdown-header" data-toc-skip>Miscellaneous</h6></li>
+ <li><a class="dropdown-item" href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a></li>
+ <li><a class="dropdown-item" href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a></li>
+ </ul></li>
+<li class="nav-item"><a class="nav-link" href="../coverage/coverage.html">Test coverage</a></li>
+<li class="nav-item"><a class="nav-link" href="../news/index.html">News</a></li>
+ </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
+ <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
+<li class="nav-item"><a class="external-link nav-link" href="https://github.com/jranke/mkin/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
+ </ul></div>
+
+
+ </div>
+</nav><div class="container template-reference-topic">
+<div class="row">
+ <main id="main" class="col-md-9"><div class="page-header">
+
+ <h1>Evaluate parent kinetics using the NAFTA guidance</h1>
+ <small class="dont-index">Source: <a href="https://github.com/jranke/mkin/blob/HEAD/R/nafta.R" class="external-link"><code>R/nafta.R</code></a></small>
+ <div class="d-none name"><code>nafta.Rd</code></div>
+ </div>
+
+ <div class="ref-description section level2">
+ <p>The function fits the SFO, IORE and DFOP models using <code><a href="mmkin.html">mmkin</a></code>
+and returns an object of class <code>nafta</code> that has methods for printing
+and plotting.</p>
+<p>Print nafta objects. The results for the three models are printed in the
+order of increasing model complexity, i.e. SFO, then IORE, and finally DFOP.</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">nafta</span><span class="op">(</span><span class="va">ds</span>, title <span class="op">=</span> <span class="cn">NA</span>, quiet <span class="op">=</span> <span class="cn">FALSE</span>, <span class="va">...</span><span class="op">)</span></span>
+<span></span>
+<span><span class="co"># S3 method for class 'nafta'</span></span>
+<span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">x</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span>, digits <span class="op">=</span> <span class="fl">3</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
+ </div>
+
+ <div class="section level2">
+ <h2 id="source">Source<a class="anchor" aria-label="anchor" href="#source"></a></h2>
+ <p>NAFTA (2011) Guidance for evaluating and calculating degradation
+kinetics in environmental media. NAFTA Technical Working Group on
+Pesticides
+<a href="https://www.epa.gov/pesticide-science-and-assessing-pesticide-risks/guidance-evaluating-and-calculating-degradation" class="external-link">https://www.epa.gov/pesticide-science-and-assessing-pesticide-risks/guidance-evaluating-and-calculating-degradation</a>
+accessed 2019-02-22</p>
+<p>US EPA (2015) Standard Operating Procedure for Using the NAFTA Guidance to
+Calculate Representative Half-life Values and Characterizing Pesticide
+Degradation
+<a href="https://www.epa.gov/pesticide-science-and-assessing-pesticide-risks/standard-operating-procedure-using-nafta-guidance" class="external-link">https://www.epa.gov/pesticide-science-and-assessing-pesticide-risks/standard-operating-procedure-using-nafta-guidance</a></p>
+ </div>
+ <div class="section level2">
+ <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>
+
+
+<dl><dt id="arg-ds">ds<a class="anchor" aria-label="anchor" href="#arg-ds"></a></dt>
+<dd><p>A dataframe that must contain one variable called "time" with the
+time values specified by the <code>time</code> argument, one column called
+"name" with the grouping of the observed values, and finally one column of
+observed values called "value".</p></dd>
+
+
+<dt id="arg-title">title<a class="anchor" aria-label="anchor" href="#arg-title"></a></dt>
+<dd><p>Optional title of the dataset</p></dd>
+
+
+<dt id="arg-quiet">quiet<a class="anchor" aria-label="anchor" href="#arg-quiet"></a></dt>
+<dd><p>Should the evaluation text be shown?</p></dd>
+
+
+<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
+<dd><p>Further arguments passed to <code><a href="mmkin.html">mmkin</a></code> (not for the
+printing method).</p></dd>
+
+
+<dt id="arg-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt>
+<dd><p>An <code>nafta</code> object.</p></dd>
+
+
+<dt id="arg-digits">digits<a class="anchor" aria-label="anchor" href="#arg-digits"></a></dt>
+<dd><p>Number of digits to be used for printing parameters and
+dissipation times.</p></dd>
+
+</dl></div>
+ <div class="section level2">
+ <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
+ <p>An list of class <code>nafta</code>. The list element named "mmkin" is the
+<code><a href="mmkin.html">mmkin</a></code> object containing the fits of the three models. The
+list element named "title" contains the title of the dataset used. The
+list element "data" contains the dataset used in the fits.</p>
+ </div>
+ <div class="section level2">
+ <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
+ <p>Johannes Ranke</p>
+ </div>
+
+ <div class="section level2">
+ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
+ <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span>
+<span class="r-in"><span> <span class="va">nafta_evaluation</span> <span class="op">&lt;-</span> <span class="fu">nafta</span><span class="op">(</span><span class="va">NAFTA_SOP_Appendix_D</span>, cores <span class="op">=</span> <span class="fl">1</span><span class="op">)</span></span></span>
+<span class="r-msg co"><span class="r-pr">#&gt;</span> The SFO model is rejected as S_SFO is equal or higher than the critical value S_c</span>
+<span class="r-msg co"><span class="r-pr">#&gt;</span> The representative half-life of the IORE model is longer than the one corresponding</span>
+<span class="r-msg co"><span class="r-pr">#&gt;</span> to the terminal degradation rate found with the DFOP model.</span>
+<span class="r-msg co"><span class="r-pr">#&gt;</span> The representative half-life obtained from the DFOP model may be used</span>
+<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">nafta_evaluation</span><span class="op">)</span></span></span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Sums of squares:</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> SFO IORE DFOP </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 1378.6832 615.7730 517.8836 </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Critical sum of squares for checking the SFO model:</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 717.4598</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Parameters:</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> $SFO</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Estimate Pr(&gt;t) Lower Upper</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> parent_0 83.7558 1.80e-14 77.18268 90.3288</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> k_parent 0.0017 7.43e-05 0.00112 0.0026</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> sigma 8.7518 1.22e-05 5.64278 11.8608</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> $IORE</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Estimate Pr(&gt;t) Lower Upper</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> parent_0 9.69e+01 NA 8.88e+01 1.05e+02</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> k__iore_parent 8.40e-14 NA 1.79e-18 3.94e-09</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> N_parent 6.68e+00 NA 4.19e+00 9.17e+00</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> sigma 5.85e+00 NA 3.76e+00 7.94e+00</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> $DFOP</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Estimate Pr(&gt;t) Lower Upper</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> parent_0 9.76e+01 1.94e-13 9.02e+01 1.05e+02</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> k1 4.24e-02 5.92e-03 2.03e-02 8.88e-02</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> k2 8.24e-04 6.48e-03 3.89e-04 1.75e-03</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> g 2.88e-01 2.47e-05 1.95e-01 4.03e-01</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> sigma 5.36e+00 2.22e-05 3.43e+00 7.30e+00</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> DTx values:</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> DT50 DT90 DT50_rep</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> SFO 407 1350 407</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> IORE 541 5190000 1560000</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> DFOP 429 2380 841</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> </span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> Representative half-life:</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 841.41</span>
+<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">nafta_evaluation</span><span class="op">)</span></span></span>
+<span class="r-plt img"><img src="nafta-1.png" alt="" width="700" height="433"></span>
+<span class="r-in"><span></span></span>
+</code></pre></div>
+ </div>
+ </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
+ </nav></aside></div>
+
+
+ <footer><div class="pkgdown-footer-left">
+ <p>Developed by Johannes Ranke.</p>
+</div>
+
+<div class="pkgdown-footer-right">
+ <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
+</div>
+
+ </footer></div>
+
+
+
+
+
+ </body></html>
+

Contact - Imprint