aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/nafta.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/nafta.html')
-rw-r--r--docs/reference/nafta.html81
1 files changed, 48 insertions, 33 deletions
diff --git a/docs/reference/nafta.html b/docs/reference/nafta.html
index c5ea9a9a..60917ff4 100644
--- a/docs/reference/nafta.html
+++ b/docs/reference/nafta.html
@@ -8,11 +8,13 @@
<title>Evaluate parent kinetics using the NAFTA guidance — nafta • mkin</title>
+
<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>
<!-- Bootstrap -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" />
+
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>
<!-- Font Awesome icons -->
@@ -32,15 +34,18 @@
-<meta property="og:title" content="Evaluate parent kinetics using the NAFTA guidance — nafta" />
-<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." />
+<meta property="og:title" content="Evaluate parent kinetics using the NAFTA guidance — nafta" />
+<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="twitter:card" content="summary" />
+
<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
@@ -111,7 +116,6 @@
<a href="../news/index.html">News</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
</ul>
@@ -133,24 +137,27 @@
</div>
<div class="ref-description">
-
- <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>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>
- <pre class="usage"><span class='fu'>nafta</span>(<span class='no'>ds</span>, <span class='kw'>title</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='no'>...</span>)</pre>
-
+ <pre class="usage"><span class='fu'>nafta</span>(<span class='no'>ds</span>, <span class='kw'>title</span> <span class='kw'>=</span> <span class='fl'>NA</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='no'>...</span>)
+
+<span class='co'># S3 method for nafta</span>
+<span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span>(<span class='no'>x</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fl'>3</span>, <span class='no'>...</span>)</pre>
+
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
<table class="ref-arguments">
<colgroup><col class="name" /><col class="desc" /></colgroup>
<tr>
<th>ds</th>
- <td><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></td>
+ <td><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></td>
</tr>
<tr>
<th>title</th>
@@ -162,31 +169,41 @@
</tr>
<tr>
<th>...</th>
- <td><p>Further arguments passed to <code><a href='mmkin.html'>mmkin</a></code>.</p></td>
+ <td><p>Further arguments passed to <code><a href='mmkin.html'>mmkin</a></code> (not for the
+printing method).</p></td>
+ </tr>
+ <tr>
+ <th>x</th>
+ <td><p>An <code>nafta</code> object.</p></td>
+ </tr>
+ <tr>
+ <th>digits</th>
+ <td><p>Number of digits to be used for printing parameters and
+dissipation times.</p></td>
</tr>
</table>
-
- <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</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>
-
<h2 class="hasAnchor" id="source"><a class="anchor" href="#source"></a>Source</h2>
- <p>NAFTA (2011) Guidance for evaluating and calculating degradation kinetics
- in environmental media. NAFTA Technical Working Group on Pesticides
+ <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'>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'>https://www.epa.gov/pesticide-science-and-assessing-pesticide-risks/standard-operating-procedure-using-nafta-guidance</a></p>
-
+ <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</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>
<h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
- <pre class="examples"><div class='input'> <span class='no'>nafta_evaluation</span> <span class='kw'>&lt;-</span> <span class='fu'>nafta</span>(<span class='no'>NAFTA_SOP_Appendix_D</span>, <span class='kw'>cores</span> <span class='kw'>=</span> <span class='fl'>1</span>)</div><div class='output co'>#&gt; <span class='message'>The SFO model is rejected as S_SFO is equal or higher than the critical value S_c</span></div><div class='output co'>#&gt; <span class='message'>The representative half-life of the IORE model is longer than the one corresponding</span></div><div class='output co'>#&gt; <span class='message'>to the terminal degradation rate found with the DFOP model.</span></div><div class='output co'>#&gt; <span class='message'>The representative half-life obtained from the DFOP model may be used</span></div><div class='input'> <span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span>(<span class='no'>nafta_evaluation</span>)</div><div class='output co'>#&gt; Sums of squares:
+ <pre class="examples"><div class='input'>
+ <span class='no'>nafta_evaluation</span> <span class='kw'>&lt;-</span> <span class='fu'>nafta</span>(<span class='no'>NAFTA_SOP_Appendix_D</span>, <span class='kw'>cores</span> <span class='kw'>=</span> <span class='fl'>1</span>)</div><div class='output co'>#&gt; <span class='message'>The SFO model is rejected as S_SFO is equal or higher than the critical value S_c</span></div><div class='output co'>#&gt; <span class='message'>The representative half-life of the IORE model is longer than the one corresponding</span></div><div class='output co'>#&gt; <span class='message'>to the terminal degradation rate found with the DFOP model.</span></div><div class='output co'>#&gt; <span class='message'>The representative half-life obtained from the DFOP model may be used</span></div><div class='input'> <span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span>(<span class='no'>nafta_evaluation</span>)</div><div class='output co'>#&gt; Sums of squares:
#&gt; SFO IORE DFOP
#&gt; 1378.6832 615.7730 517.8836
#&gt;
@@ -223,17 +240,15 @@
#&gt; DFOP 429 2380 841
#&gt;
#&gt; Representative half-life:
-#&gt; [1] 841.41</div><div class='input'> <span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>nafta_evaluation</span>)</div><div class='img'><img src='nafta-1.png' alt='' width='700' height='433' /></div></pre>
+#&gt; [1] 841.41</div><div class='input'> <span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>nafta_evaluation</span>)</div><div class='img'><img src='nafta-1.png' alt='' width='700' height='433' /></div><div class='input'>
+</div></pre>
</div>
<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="#source">Source</a></li>
-
+ <li><a href="#value">Value</a></li>
<li><a href="#examples">Examples</a></li>
</ul>

Contact - Imprint