aboutsummaryrefslogtreecommitdiff
path: root/inst/web/mkinerrmin.html
blob: 25179d524d20027a398b6652547696bb84402546 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
<title>mkinerrmin. mkin 0.9.44.9000</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="author" content="">

<link href="css/bootstrap.css" rel="stylesheet">
<link href="css/bootstrap-responsive.css" rel="stylesheet">
<link href="css/highlight.css" rel="stylesheet">
<link href="css/staticdocs.css" rel="stylesheet">

<!--[if lt IE 9]>
  <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->

<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    tex2jax: {
      inlineMath: [ ['$','$'], ["\\(","\\)"] ],
      processEscapes: true
    }
  });
</script>
<script type="text/javascript"
  src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
</script>
  </head>

  <body>
    <div class="navbar">
  <div class="navbar-inner">
    <div class="container">
      <a class="brand" href="#">mkin 0.9.44.9000</a>
      <div class="nav">
        <ul class="nav">
          <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>
        </ul>
      </div>
    </div>
  </div>
</div>

    <div class="container">
      <header>
        
      </header>
      
      <h1>
Calculate the minimum error to assume in order to pass the variance test
</h1>

<div class="row">
  <div class="span8">
    <h2>Usage</h2>
    <pre><div>mkinerrmin(fit, alpha&nbsp;=&nbsp;0.05)</div></pre>
    
    <h2>Arguments</h2>
    <dl>
      <dt>fit</dt>
      <dd>
    an object of class <code><a href='mkinfit.html'>mkinfit</a></code>.
  </dd>
      <dt>alpha</dt>
      <dd>
    The confidence level chosen for the chi-squared test.
</dd>
    </dl>
    
    <div class="Description">
      <h2>Description</h2>

      <p>This function uses <code><a href='http://www.inside-r.org/r-doc/stats/optimize'>optimize</a></code> in order to iteratively find the
smallest relative error still resulting in passing the chi-squared test
as defined in the FOCUS kinetics report from 2006.</p>
  
    </div>

    <div class="Value">
      <h2>Value</h2>

      <p><dl>
  A dataframe with the following components:
  <dt>err.min</dt><dd>The relative error, expressed as a fraction.</dd></p>
  
      <p><dt>n.optim</dt><dd>The number of optimised parameters attributed to the data series.</dd></p>
  
      <p><dt>df</dt><dd>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.</dd></p>
  
      <p>The dataframe has one row for the total dataset and one further row for
  each observed state variable in the model.
</dl></p>
  
    </div>

    <div class="Details">
      <h2>Details</h2>

      <p>This function is used internally by <code><a href='summary.mkinfit.html'>summary.mkinfit</a></code>.</p>
  
    </div>

    <div class="References">
      <h2>References</h2>

      <p>FOCUS (2006) &#147;Guidance Document on Estimating Persistence and
  Degradation Kinetics from Environmental Fate Studies on Pesticides in EU
  Registration&#148; 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>
  
    </div>
    
    <h2 id="examples">Examples</h2>
    <pre class="examples"><div class='input'>SFO_SFO = mkinmod(parent = list(type = &quot;SFO&quot;, to = &quot;m1&quot;),
                  m1 = list(type = &quot;SFO&quot;),
                  use_of_ff = &quot;max&quot;)
</div>
<strong class='message'>Successfully compiled differential equation model from auto-generated C code.</strong>
<div class='input'>
fit_FOCUS_D = mkinfit(SFO_SFO, FOCUS_2006_D, quiet = TRUE)
round(mkinerrmin(fit_FOCUS_D), 4)
</div>
<div class='output'>         err.min n.optim df
All data  0.0640       4 15
parent    0.0646       2  7
m1        0.0469       2  8
</div>
<div class='input'>fit_FOCUS_E = mkinfit(SFO_SFO, FOCUS_2006_E, quiet = TRUE)
round(mkinerrmin(fit_FOCUS_E), 4)
</div>
<div class='output'>         err.min n.optim df
All data  0.1544       4 13
parent    0.1659       2  7
m1        0.1095       2  6
</div></pre>
  </div>
  <div class="span4">
    <!-- <ul>
      <li>mkinerrmin</li>
    </ul>
    <ul>
      <li> manip </li>
    </ul> -->
      
        
  </div>
</div>
      
      <footer>
      <p class="pull-right"><a href="#">Back to top</a></p>
<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="http://twitter.github.com/bootstrap">bootstrap</a>.</p>
      </footer>
    </div>
  </body>
</html>

Contact - Imprint