aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/summary.mkinfit.html
blob: cb6beda282b99832670ad3098ec2a68f98a5614f (plain) (tree) 
38f9e15f








517d9378

38f9e15f



38f9e15f

38f9e15f

8f38147e

38f9e15f





6653ff25


38f9e15f

39b2c2c7



38f9e15f



39b2c2c7



d185c26e







39b2c2c7



38f9e15f

ccc70e82

38f9e15f





ccc70e82


38f9e15f



8f38147e

38f9e15f

8f38147e

38f9e15f







39b2c2c7


70d158c4

39b2c2c7

38f9e15f

39b2c2c7

38f9e15f



d852e9e0

38f9e15f

30f55769

















70d158c4

6653ff25


70d158c4

30f55769

ccc70e82



30f55769

38f9e15f

ccc70e82



38f9e15f

8f38147e

38f9e15f

6653ff25

38f9e15f

39b2c2c7

38f9e15f



8f38147e

38f9e15f



39b2c2c7

8f38147e


517d9378

39b2c2c7


8f38147e

38f9e15f

39b2c2c7

38f9e15f






39b2c2c7

38f9e15f

ccc70e82

38f9e15f




39b2c2c7

ccc70e82































38f9e15f

8f38147e

38f9e15f

8f38147e

38f9e15f

ccc70e82


















8f38147e


38f9e15f

8f38147e

38f9e15f



6653ff25

38f9e15f

8f38147e

f39815aa

70d158c4

0b98c459

851f146e


38f9e15f


98d684be

38f9e15f



851f146e

38f9e15f


























































f39815aa

38f9e15f

8f38147e












38f9e15f








8f38147e

f39815aa

8f38147e



6653ff25

8f38147e


38f9e15f



39b2c2c7


38f9e15f


d185c26e

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
161
162
163
164
165
166
167
168
169
170
171
172

173

174

175

176

177

178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195

196
197

198

199

200
201
202

203

204

205

206

207

208

209
210

211
212

213

214
215
216

217

218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275

276

277

278
279
280
281
282
283
284
285
286
287
288
289

290
291
292
293
294
295
296
297

298

299

300
301
302

303

304
305

306
307
308

309
310

311
312

313








                                                                      
                                                                              


                                                                                                                                                                               
                  
 
                                                                                                                                                                                                                




                                                                                                                                                                                                                      

                                                                                                                                                                                                              
 


                                                                                                                                                                                         


                                             


 






                                                                                                          


 
                
                                                                                                  




                                                                               

 


         
                                                    
              
                                                                            






                                                                                                         

                                                            
                                                                                                                                
             
          
 


                                                      
                                                          
     
















                                                                                                 
                                                                                                   

         
                                                                                                                             
         


                                                                                                      
       
     


                                       
           
      
                                              
        
           
      


                                
 


               
                 

                                 
                                               

                                                                  
          
 
                                 





                                                                                     
          
 
                                                                      



                                                                                                                                                                                                                                                                                                                                                                
                                                                                               






























                                                                                             
    
                                                                                   
 
                                                       
                                                                

















                                                                                                         

                                                                                                  
 
                                                                          


                                                                             
                                                                                                                                           
    
 
                                                                                            
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    
                                              

                                                

                
                                            


                                                       
                                                                           

























































                                                                                
                                                            
        











                                                         







                   
                             
                                     


                     
                                                                         

      


               

  

         
 
<!-- 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 method for class "mkinfit" — 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">

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" crossorigin="anonymous"></script>

<!-- sticky kit -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>



<meta property="og:title" content="Summary method for class "mkinfit" — summary.mkinfit" />

<meta property="og:description" content="Lists model equations, the summary as returned by summary.modFit,
  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." />
<meta name="twitter:card" content="summary" />



<!-- mathjax -->
<script src='https://mathjax.rstudio.com/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>
      <span class="navbar-brand">
        <a class="navbar-link" href="../index.html">mkin</a>
        <span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.9.47.5</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../reference/index.html">Functions and data</a>
</li>
<li class="dropdown">
  <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
    Articles
     
    <span class="caret"></span>
  </a>
  <ul class="dropdown-menu" role="menu">
    <li>
      <a href="../articles/mkin.html">Introduction to mkin</a>
    </li>
    <li>
      <a href="../articles/FOCUS_D.html">Example evaluation of FOCUS Example Dataset D</a>
    </li>
    <li>
      <a href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a>
    </li>
    <li>
      <a href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a>
    </li>
    <li>
      <a href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a>
    </li>
    <li>
      <a href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a>
    </li>
  </ul>
</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>Summary method for class "mkinfit"</h1>
    
    <div class="hidden name"><code>summary.mkinfit.Rd</code></div>
    </div>

    <div class="ref-description">
    
    <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>
    
    </div>

    <pre class="usage"><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>
    <table class="ref-arguments">
    <colgroup><col class="name" /><col class="desc" /></colgroup>
    <tr>
      <th>object</th>
      <td><p>an object of class <code><a href='mkinfit.html'>mkinfit</a></code>.</p></td>
    </tr>
    <tr>
      <th>x</th>
      <td><p>an object of class <code>summary.mkinfit</code>.</p></td>
    </tr>
    <tr>
      <th>data</th>
      <td><p>logical, indicating whether the data should be included in the summary.</p></td>
    </tr>
    <tr>
      <th>distimes</th>
      <td><p>logical, indicating whether DT50 and DT90 values should be included.</p></td>
    </tr>
    <tr>
      <th>alpha</th>
      <td><p>error level for confidence interval estimation from t distribution</p></td>
    </tr>
    <tr>
      <th>digits</th>
      <td><p>Number of digits to use for printing</p></td>
    </tr>
    <tr>
      <th>&#8230;</th>
      <td><p>optional arguments passed to methods like <code>print</code>.</p></td>
    </tr>
    </table>
    
    <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>
<dt>version, Rversion</dt><dd><p>The mkin and R versions used</p></dd>
  <dt>date.fit, date.summary</dt><dd><p>The dates where the fit and the summary were produced</p></dd>
  <dt>use_of_ff</dt><dd><p>Was maximum or minimum use made of formation fractions</p></dd>
  <dt>residuals, residualVariance, sigma, modVariance, df</dt><dd><p>As in summary.modFit</p></dd>
  <dt>cov.unscaled, cov.scaled, info, niter, stopmess, par</dt><dd><p>As in summary.modFit</p></dd>
  <dt>bpar</dt><dd><p>Optimised and backtransformed parameters</p></dd>
  <dt>diffs </dt><dd><p>The differential equations used in the model</p></dd>
  <dt>data </dt><dd><p>The data (see Description above).</p></dd>
  <dt>start </dt><dd><p>The starting values and bounds, if applicable, for optimised parameters.</p></dd>
  <dt>fixed </dt><dd><p>The values of fixed parameters.</p></dd>
  <dt>errmin </dt><dd><p>The chi2 error levels for each observed variable.</p></dd>
  <dt>bparms.ode </dt><dd><p>All backtransformed ODE parameters, for use as starting parameters for
    related models.</p></dd>
  <dt>ff </dt><dd><p>The estimated formation fractions derived from the fitted model.</p></dd>
  <dt>distimes </dt><dd><p>The DT50 and DT90 values for each observed variable.</p></dd>
  <dt>SFORB</dt><dd><p>If applicable, eigenvalues of SFORB components of the model.</p></dd>
  The print method is called for its side effect, i.e. printing the summary.

    
    <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>
    

    <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'><a href='mkinsub.html'>mkinsub</a></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 used for fitting:    0.9.47.5 
#&gt; R version used for fitting:       3.5.1 
#&gt; Date of fit:     Fri Sep 14 18:22:10 2018 
#&gt; Date of summary: Fri Sep 14 18:22:10 2018 
#&gt; 
#&gt; Equations:
#&gt; d_parent/dt = - 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.076 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</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.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="http://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>

      </footer>
   </div>

  

  </body>
</html>

Contact - Imprint