aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/summary.mkinfit.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/reference/summary.mkinfit.html')
-rw-r--r--docs/reference/summary.mkinfit.html247
1 files changed, 247 insertions, 0 deletions
diff --git a/docs/reference/summary.mkinfit.html b/docs/reference/summary.mkinfit.html
new file mode 100644
index 00000000..b88a5469
--- /dev/null
+++ b/docs/reference/summary.mkinfit.html
@@ -0,0 +1,247 @@
+<!-- Generated by pkgdown: do not edit by hand -->
+<!DOCTYPE html>
+<html>
+ <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>
+ — summary.mkinfit • mkin</title>
+
+<!-- jquery -->
+<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
+<!-- Bootstrap -->
+
+<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+<!-- Font Awesome icons -->
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
+
+
+<!-- pkgdown -->
+<link href="../pkgdown.css" rel="stylesheet">
+<script src="../jquery.sticky-kit.min.js"></script>
+<script src="../pkgdown.js"></script>
+
+<!-- mathjax -->
+<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></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]-->
+ </head>
+
+ <body>
+ <div class="container template-reference-topic">
+ <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">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="../index.html">mkin</a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="../reference/index.html">Reference</a>
+</li>
+<li>
+ <a href="../articles/index.html">Articles</a>
+</li>
+<li>
+ <a href="../news/index.html">News</a>
+</li>
+ </ul>
+
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div><!--/.container -->
+</div><!--/.navbar -->
+
+
+ </header>
+
+ <div class="row">
+ <div class="col-md-9 contents">
+ <div class="page-header">
+ <h1>
+</h1>
+ </div>
+
+
+ <p>Lists model equations, the summary as returned by <code>summary.modFit</code>,
+ the chi2 error levels calculated according to FOCUS guidance (2006) as far
+ as defined therein, and optionally the data, consisting of observed, predicted
+ and residual values.</p>
+
+
+ <pre><span class='co'># S3 method for mkinfit</span>
+<span class='fu'>summary</span>(<span class='no'>object</span>, <span class='kw'>data</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>distimes</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>, <span class='kw'>alpha</span> <span class='kw'>=</span> <span class='fl'>0.05</span>, <span class='no'>...</span>)
+<span class='co'># S3 method for summary.mkinfit</span>
+<span class='fu'>print</span>(<span class='no'>x</span>, <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fu'>max</span>(<span class='fl'>3</span>, <span class='fu'>getOption</span>(<span class='st'>"digits"</span>) - <span class='fl'>3</span>), <span class='no'>...</span>)</pre>
+
+ <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2>
+ <dl class="dl-horizontal">
+ <dt>object</dt>
+ <dd>
+ an object of class <code><a href='mkinfit.html'>mkinfit</a></code>.
+</dd>
+ <dt>x</dt>
+ <dd>
+ an object of class <code>summary.mkinfit</code>.
+</dd>
+ <dt>data</dt>
+ <dd>
+ logical, indicating whether the data should be included in the summary.
+</dd>
+ <dt>distimes</dt>
+ <dd>
+ logical, indicating whether DT50 and DT90 values should be included.
+</dd>
+ <dt>alpha</dt>
+ <dd>
+ error level for confidence interval estimation from t distribution
+</dd>
+ <dt>digits</dt>
+ <dd>
+ Number of digits to use for printing
+</dd>
+ <dt>&amp;#8230;</dt>
+ <dd>
+ optional arguments passed to methods like <code>print</code>.
+</dd>
+ </dl>
+
+ <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
+
+ <p>The summary function returns a list derived from
+ <code>summary.modFit</code>, with components, among others</p>
+ <p>The print method is called for its side effect, i.e. printing the summary.</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://focus.jrc.ec.europa.eu/dk'>http://focus.jrc.ec.europa.eu/dk</a></p>
+
+
+ <h2 class="hasAnchor" id="examples">
+ <a class="anchor" href="#examples"></a>
+ Examples
+ </h2>
+ <pre class="examples"><div class='input'> <span class='fu'>summary</span>(<span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='fu'><a href='mkinmod.html'>mkinmod</a></span>(<span class='kw'>parent</span> <span class='kw'>=</span> <span class='fu'>list</span>(<span class='kw'>type</span> <span class='kw'>=</span> <span class='st'>"SFO"</span>)), <span class='no'>FOCUS_2006_A</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>))</div><div class='output co'>#&gt; mkin version: 0.9.44.9000
+#&gt; R version: 3.3.1
+#&gt; Date of fit: Wed Oct 26 23:50:50 2016
+#&gt; Date of summary: Wed Oct 26 23:50:50 2016
+#&gt;
+#&gt; Equations:
+#&gt; d_parent = - k_parent_sink * parent
+#&gt;
+#&gt; Model predictions using solution type analytical
+#&gt;
+#&gt; Fitted with method Port using 35 model solutions performed in 0.083 s
+#&gt;
+#&gt; Weighting: none
+#&gt;
+#&gt; Starting values for parameters to be optimised:
+#&gt; value type
+#&gt; parent_0 101.24 state
+#&gt; k_parent_sink 0.10 deparm
+#&gt;
+#&gt; Starting values for the transformed parameters actually optimised:
+#&gt; value lower upper
+#&gt; parent_0 101.240000 -Inf Inf
+#&gt; log_k_parent_sink -2.302585 -Inf Inf
+#&gt;
+#&gt; Fixed parameter values:
+#&gt; None
+#&gt;
+#&gt; Optimised, transformed parameters with symmetric confidence intervals:
+#&gt; Estimate Std. Error Lower Upper
+#&gt; parent_0 109.200 4.3910 98.410 119.900
+#&gt; log_k_parent_sink -3.291 0.1152 -3.573 -3.009
+#&gt;
+#&gt; Parameter correlation:
+#&gt; parent_0 log_k_parent_sink
+#&gt; parent_0 1.000 0.575
+#&gt; log_k_parent_sink 0.575 1.000
+#&gt;
+#&gt; Residual standard error: 6.08 on 6 degrees of freedom
+#&gt;
+#&gt; Backtransformed parameters:
+#&gt; Confidence intervals for internally transformed parameters are asymmetric.
+#&gt; t-test (unrealistically) based on the assumption of normal distribution
+#&gt; for estimators of untransformed parameters.
+#&gt; Estimate t value Pr(&gt;t) Lower Upper
+#&gt; parent_0 109.20000 24.860 1.394e-07 98.41000 119.90000
+#&gt; k_parent_sink 0.03722 8.679 6.457e-05 0.02807 0.04934
+#&gt;
+#&gt; Chi2 error levels in percent:
+#&gt; err.min n.optim df
+#&gt; All data 8.385 2 6
+#&gt; parent 8.385 2 6
+#&gt;
+#&gt; Resulting formation fractions:
+#&gt; ff
+#&gt; parent_sink 1
+#&gt;
+#&gt; Estimated disappearance times:
+#&gt; DT50 DT90
+#&gt; parent 18.62 61.87
+#&gt;
+#&gt; Data:
+#&gt; time variable observed predicted residual
+#&gt; 0 parent 101.24 109.153 -7.9132
+#&gt; 3 parent 99.27 97.622 1.6484
+#&gt; 7 parent 90.11 84.119 5.9913
+#&gt; 14 parent 72.19 64.826 7.3641
+#&gt; 30 parent 29.71 35.738 -6.0283
+#&gt; 62 parent 5.98 10.862 -4.8818
+#&gt; 90 parent 1.54 3.831 -2.2911
+#&gt; 118 parent 0.39 1.351 -0.9613
+#&gt; </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="#references">References</a></li>
+
+ <li><a href="#examples">Examples</a></li>
+ </ul>
+
+ <h2>Author</h2>
+
+ Johannes Ranke
+
+ </div>
+</div>
+
+ <footer>
+ <div class="copyright">
+ <p>Developed by Johannes Ranke, Eurofins Regulatory AG.</p>
+</div>
+
+<div class="pkgdown">
+ <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+</div>
+
+ </footer>
+ </div>
+
+ </body>
+</html>

Contact - Imprint