aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/mkinerrmin.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/mkinerrmin.html')
-rw-r--r--docs/reference/mkinerrmin.html226
1 files changed, 85 insertions, 141 deletions
diff --git a/docs/reference/mkinerrmin.html b/docs/reference/mkinerrmin.html
index f22b4350..b72017fe 100644
--- a/docs/reference/mkinerrmin.html
+++ b/docs/reference/mkinerrmin.html
@@ -1,68 +1,13 @@
-<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
-<meta http-equiv="X-UA-Compatible" content="IE=edge">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-<title>Calculate the minimum error to assume in order to pass the variance test — mkinerrmin • mkin</title>
-
-
-<!-- jquery -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
-<!-- Bootstrap -->
-
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
-
-<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
-
-<!-- bootstrap-toc -->
-<link rel="stylesheet" href="../bootstrap-toc.css">
-<script src="../bootstrap-toc.js"></script>
-
-<!-- Font Awesome icons -->
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
-<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
-
-<!-- clipboard.js -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
-
-<!-- headroom.js -->
-<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
-
-<!-- pkgdown -->
-<link href="../pkgdown.css" rel="stylesheet">
-<script src="../pkgdown.js"></script>
-
-
-
-
-<meta property="og:title" content="Calculate the minimum error to assume in order to pass the variance test — mkinerrmin" />
-<meta property="og:description" content="This function finds the smallest relative error still resulting in passing
-the chi-squared test as defined in the FOCUS kinetics report from 2006." />
-
-
-
-
-<!-- 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>
-
-<!--[if lt IE 9]>
+<!-- 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.0"><title>Calculate the minimum error to assume in order to pass the variance test — mkinerrmin • mkin</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Calculate the minimum error to assume in order to pass the variance test — mkinerrmin"><meta property="og:description" content="This function finds the smallest relative error still resulting in passing
+the chi-squared test as defined in the FOCUS kinetics report from 2006."><!-- 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><!--[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]-->
-
-
+<![endif]--></head><body data-spy="scroll" data-target="#toc">
+
- </head>
-
- <body data-spy="scroll" data-target="#toc">
<div class="container template-reference-topic">
- <header>
- <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <header><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" aria-expanded="false">
@@ -73,13 +18,12 @@ the chi-squared test as defined in the FOCUS kinetics report from 2006." />
</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.0.3</span>
+ <span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">1.1.0</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
- <ul class="nav navbar-nav">
- <li>
+ <ul class="nav navbar-nav"><li>
<a href="../reference/index.html">Functions and data</a>
</li>
<li class="dropdown">
@@ -88,8 +32,7 @@ the chi-squared test as defined in the FOCUS kinetics report from 2006." />
<span class="caret"></span>
</a>
- <ul class="dropdown-menu" role="menu">
- <li>
+ <ul class="dropdown-menu" role="menu"><li>
<a href="../articles/mkin.html">Introduction to mkin</a>
</li>
<li>
@@ -99,6 +42,9 @@ the chi-squared test as defined in the FOCUS kinetics report from 2006." />
<a href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a>
</li>
<li>
+ <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>
</li>
<li>
@@ -113,34 +59,27 @@ the chi-squared test as defined in the FOCUS kinetics report from 2006." />
<li>
<a href="../articles/web_only/benchmarks.html">Some benchmark timings</a>
</li>
- </ul>
-</li>
+ </ul></li>
<li>
<a href="../news/index.html">News</a>
</li>
- </ul>
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="https://github.com/jranke/mkin/">
+ </ul><ul class="nav navbar-nav navbar-right"><li>
+ <a href="https://github.com/jranke/mkin/" class="external-link">
<span class="fab fa-github fa-lg"></span>
</a>
</li>
- </ul>
-
- </div><!--/.nav-collapse -->
+ </ul></div><!--/.nav-collapse -->
</div><!--/.container -->
</div><!--/.navbar -->
- </header>
-
-<div class="row">
+ </header><div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Calculate the minimum error to assume in order to pass the variance test</h1>
- <small class="dont-index">Source: <a href='https://github.com/jranke/mkin/blob/master/R/mkinerrmin.R'><code>R/mkinerrmin.R</code></a></small>
+ <small class="dont-index">Source: <a href="https://github.com/jranke/mkin/blob/HEAD/R/mkinerrmin.R" class="external-link"><code>R/mkinerrmin.R</code></a></small>
<div class="hidden name"><code>mkinerrmin.Rd</code></div>
</div>
@@ -149,89 +88,94 @@ the chi-squared test as defined in the FOCUS kinetics report from 2006." />
the chi-squared test as defined in the FOCUS kinetics report from 2006.</p>
</div>
- <pre class="usage"><span class='fu'>mkinerrmin</span><span class='op'>(</span><span class='va'>fit</span>, alpha <span class='op'>=</span> <span class='fl'>0.05</span><span class='op'>)</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>fit</th>
- <td><p>an object of class <code><a href='mkinfit.html'>mkinfit</a></code>.</p></td>
- </tr>
- <tr>
- <th>alpha</th>
- <td><p>The confidence level chosen for the chi-squared test.</p></td>
- </tr>
- </table>
-
- <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
+ <div id="ref-usage">
+ <div class="sourceCode"><pre class="sourceCode r"><code><span class="fu">mkinerrmin</span><span class="op">(</span><span class="va">fit</span>, alpha <span class="op">=</span> <span class="fl">0.05</span><span class="op">)</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>alpha</dt>
+<dd><p>The confidence level chosen for the chi-squared test.</p></dd>
+</dl></div>
+ <div id="value">
+ <h2>Value</h2>
<p>A dataframe with the following components:</p>
-<dt>err.min</dt><dd><p>The
-relative error, expressed as a fraction.</p></dd> <dt>n.optim</dt><dd><p>The number of
-optimised parameters attributed to the data series.</p></dd> <dt>df</dt><dd><p>The number of
+<dl><dt>err.min</dt>
+<dd><p>The
+relative error, expressed as a fraction.</p></dd>
+<dt>n.optim</dt>
+<dd><p>The number of
+optimised parameters attributed to the data series.</p></dd>
+<dt>df</dt>
+<dd><p>The number of
remaining degrees of freedom for the chi2 error level calculations. Note
that mean values are used for the chi2 statistic and therefore every time
-point with observed values in the series only counts one time.</p></dd> The
+point with observed values in the series only counts one time.</p></dd>
+</dl><p>The
dataframe has one row for the total dataset and one further row for each
-observed state variable in the model.
-
- <h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2>
-
- <p>This function is used internally by <code><a href='summary.mkinfit.html'>summary.mkinfit</a></code>.</p>
- <h2 class="hasAnchor" id="references"><a class="anchor" href="#references"></a>References</h2>
-
- <p>FOCUS (2006) &#8220;Guidance Document on Estimating Persistence
+observed state variable in the model.</p>
+ </div>
+ <div id="details">
+ <h2>Details</h2>
+ <p>This function is used internally by <code><a href="summary.mkinfit.html">summary.mkinfit</a></code>.</p>
+ </div>
+ <div id="references">
+ <h2>References</h2>
+ <p>FOCUS (2006) “Guidance Document on Estimating Persistence
and Degradation Kinetics from Environmental Fate Studies on Pesticides in EU
-Registration&#8221; Report of the FOCUS Work Group on Degradation Kinetics, EC
+Registration” Report of the FOCUS Work Group on Degradation Kinetics, EC
Document Reference Sanco/10058/2005 version 2.0, 434 pp,
-<a href='http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics'>http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics</a></p>
-
- <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
- <pre class="examples"><div class='input'>
-<span class='va'>SFO_SFO</span> <span class='op'>=</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span><span class='op'>(</span>parent <span class='op'>=</span> <span class='fu'><a href='mkinmod.html'>mkinsub</a></span><span class='op'>(</span><span class='st'>"SFO"</span>, to <span class='op'>=</span> <span class='st'>"m1"</span><span class='op'>)</span>,
- m1 <span class='op'>=</span> <span class='fu'><a href='mkinmod.html'>mkinsub</a></span><span class='op'>(</span><span class='st'>"SFO"</span><span class='op'>)</span>,
- use_of_ff <span class='op'>=</span> <span class='st'>"max"</span><span class='op'>)</span>
-</div><div class='output co'>#&gt; <span class='message'>Temporary DLL for differentials generated and loaded</span></div><div class='input'>
-<span class='va'>fit_FOCUS_D</span> <span class='op'>=</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span><span class='op'>(</span><span class='va'>SFO_SFO</span>, <span class='va'>FOCUS_2006_D</span>, quiet <span class='op'>=</span> <span class='cn'>TRUE</span><span class='op'>)</span>
-</div><div class='output co'>#&gt; <span class='warning'>Warning: Observations with value of zero were removed from the data</span></div><div class='input'><span class='fu'><a href='https://rdrr.io/r/base/Round.html'>round</a></span><span class='op'>(</span><span class='fu'>mkinerrmin</span><span class='op'>(</span><span class='va'>fit_FOCUS_D</span><span class='op'>)</span>, <span class='fl'>4</span><span class='op'>)</span>
-</div><div class='output co'>#&gt; err.min n.optim df
-#&gt; All data 0.0640 4 15
-#&gt; parent 0.0646 2 7
-#&gt; m1 0.0469 2 8</div><div class='input'><span class='co'># \dontrun{</span>
- <span class='va'>fit_FOCUS_E</span> <span class='op'>=</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span><span class='op'>(</span><span class='va'>SFO_SFO</span>, <span class='va'>FOCUS_2006_E</span>, quiet <span class='op'>=</span> <span class='cn'>TRUE</span><span class='op'>)</span>
- <span class='fu'><a href='https://rdrr.io/r/base/Round.html'>round</a></span><span class='op'>(</span><span class='fu'>mkinerrmin</span><span class='op'>(</span><span class='va'>fit_FOCUS_E</span><span class='op'>)</span>, <span class='fl'>4</span><span class='op'>)</span>
-</div><div class='output co'>#&gt; err.min n.optim df
-#&gt; All data 0.1544 4 13
-#&gt; parent 0.1659 2 7
-#&gt; m1 0.1095 2 6</div><div class='input'><span class='co'># }</span>
-
-</div></pre>
+<a href="http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics" class="external-link">http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics</a></p>
+ </div>
+
+ <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">SFO_SFO</span> <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinmod</a></span><span class="op">(</span>parent <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span>, to <span class="op">=</span> <span class="st">"m1"</span><span class="op">)</span>,</span>
+<span class="r-in"> m1 <span class="op">=</span> <span class="fu"><a href="mkinmod.html">mkinsub</a></span><span class="op">(</span><span class="st">"SFO"</span><span class="op">)</span>,</span>
+<span class="r-in"> use_of_ff <span class="op">=</span> <span class="st">"max"</span><span class="op">)</span></span>
+<span class="r-msg co"><span class="r-pr">#&gt;</span> Temporary DLL for differentials generated and loaded</span>
+<span class="r-in"></span>
+<span class="r-in"><span class="va">fit_FOCUS_D</span> <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_2006_D</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span class="r-in"><span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="fu">mkinerrmin</span><span class="op">(</span><span class="va">fit_FOCUS_D</span><span class="op">)</span>, <span class="fl">4</span><span class="op">)</span></span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> err.min n.optim df</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> All data 0.0640 4 15</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> parent 0.0646 2 7</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> m1 0.0469 2 8</span>
+<span class="r-in"><span class="co"># \dontrun{</span></span>
+<span class="r-in"> <span class="va">fit_FOCUS_E</span> <span class="op">=</span> <span class="fu"><a href="mkinfit.html">mkinfit</a></span><span class="op">(</span><span class="va">SFO_SFO</span>, <span class="va">FOCUS_2006_E</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span>
+<span class="r-in"> <span class="fu"><a href="https://rdrr.io/r/base/Round.html" class="external-link">round</a></span><span class="op">(</span><span class="fu">mkinerrmin</span><span class="op">(</span><span class="va">fit_FOCUS_E</span><span class="op">)</span>, <span class="fl">4</span><span class="op">)</span></span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> err.min n.optim df</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> All data 0.1544 4 13</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> parent 0.1659 2 7</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> m1 0.1095 2 6</span>
+<span class="r-in"><span class="co"># }</span></span>
+<span class="r-in"></span>
+</code></pre></div>
+ </div>
</div>
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
- <nav id="toc" data-toggle="toc" class="sticky-top">
- <h2 data-toc-skip>Contents</h2>
- </nav>
- </div>
+ <nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
+ </nav></div>
</div>
- <footer>
- <div class="copyright">
- <p>Developed by Johannes Ranke.</p>
+ <footer><div class="copyright">
+ <p></p><p>Developed by Johannes Ranke.</p>
</div>
<div class="pkgdown">
- <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
+ <p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.2.</p>
</div>
- </footer>
- </div>
+ </footer></div>
- </body>
-</html>
+
+ </body></html>

Contact - Imprint