aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/mkinerrmin.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2019-10-25 02:10:08 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2019-10-25 02:10:08 +0200
commitaf2e1540cdad2fd00bb6216a38a754ff748629ad (patch)
tree9ec5d1ff3050c9fa826636536fc60dbda9edb1e4 /docs/reference/mkinerrmin.html
parent0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 (diff)
Static documentation rebuilt by pkgdown
Diffstat (limited to 'docs/reference/mkinerrmin.html')
-rw-r--r--docs/reference/mkinerrmin.html57
1 files changed, 26 insertions, 31 deletions
diff --git a/docs/reference/mkinerrmin.html b/docs/reference/mkinerrmin.html
index 941e30f5..1a31bc60 100644
--- a/docs/reference/mkinerrmin.html
+++ b/docs/reference/mkinerrmin.html
@@ -8,11 +8,13 @@
<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.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,14 +34,15 @@
-<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." />
+<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." />
<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>
@@ -110,7 +113,6 @@ chi-squared test as defined in the FOCUS kinetics report from 2006." />
<a href="../news/index.html">News</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
</ul>
@@ -132,14 +134,12 @@ chi-squared test as defined in the FOCUS kinetics report from 2006." />
</div>
<div class="ref-description">
-
- <p>This function finds the smallest relative error still resulting in passing the
-chi-squared test as defined in the FOCUS kinetics report from 2006.</p>
-
+ <p>This function finds the smallest relative error still resulting in passing
+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='no'>fit</span>, <span class='kw'>alpha</span> <span class='kw'>=</span> <span class='fl'>0.05</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>
@@ -152,35 +152,33 @@ chi-squared test as defined in the FOCUS kinetics report from 2006.</p>
<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>
<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 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 dataframe has one row for the total dataset and one further row for
- each observed state variable in the model.
+<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
+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 and
- Degradation Kinetics from Environmental Fate Studies on Pesticides in EU
- Registration&#8221; 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>
-
+ <p>FOCUS (2006) &#8220;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
+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='no'>SFO_SFO</span> <span class='kw'>=</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(<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='kw'>to</span> <span class='kw'>=</span> <span class='st'>"m1"</span>),
+ <pre class="examples"><div class='input'>
+<span class='no'>SFO_SFO</span> <span class='kw'>=</span> <span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(<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='kw'>to</span> <span class='kw'>=</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>),
<span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"max"</span>)</div><div class='output co'>#&gt; <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'>
<span class='no'>fit_FOCUS_D</span> <span class='kw'>=</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='no'>SFO_SFO</span>, <span class='no'>FOCUS_2006_D</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</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='fu'>mkinerrmin</span>(<span class='no'>fit_FOCUS_D</span>), <span class='fl'>4</span>)</div><div class='output co'>#&gt; err.min n.optim df
@@ -192,19 +190,16 @@ chi-squared test as defined in the FOCUS kinetics report from 2006.</p>
#&gt; All data 0.1544 4 13
#&gt; parent 0.1659 2 7
#&gt; m1 0.1095 2 6</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="#details">Details</a></li>
-
<li><a href="#references">References</a></li>
-
<li><a href="#examples">Examples</a></li>
</ul>

Contact - Imprint