aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/AIC.mmkin.html
blob: 516e60099ba7dbf90d2b22d11cc57676bffe5f03 (plain) (tree)
1
2
3
4
5
6
7
8
9
               


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             
                                                                          
 


                                                                                                                                        

                                                              

                                                                                                                                           
 


                                                                                                                                                                                
 
                                                           
                                                                                                                                      
                              





























                                                                                                                                                                                                         

                 
 



                                                            

                                                                

                                                                                                                                                                     

          
                                                

                                                                                  

          

                                                                                             
                                                                                                                              

                                                                                                                                                                                                                                                                                 
                                                                  
                                                                                                                                                                                                                                             
          
 

                                                                                                 


                                                                                                

                                                                                          

 
                                                                               
                                                         

 
                                                                             
                                        
 
           

                                                                                     
                                                                      
                                                       
          

                                                                                        
                         
          
 

                                                                                                      




                                                                                                                                                                                                                                                                                                                                                                                                                           

                                                                                                                                  



                                                                                                                                                                                                                                                                                                                                                                                                        
                                                                          
                                                                                                                                                                                                                                                                                                                                                                                                                               
                                                                          



                                                                                                                                                                                                                                                                                                         

                                                                              
                                                                              
                                                                              
                                                                                                                                                                                                                                                                                                                                                                                                                                                              

                                                                              
                                                                              
                                                                              
                                                                                                                                                                                                                                                                                                                                                                                         

                                                                              
                                                                              
                                                                              


                                                                                                                                                                                                                                                                                                         



                                                                              
                                                                                                                                                                                                                                                                                                         



                                                                              

                                         

                   
                                                                                                   
                        
 
 
                                             
                                     

      
                                  
                                                                                                      
      
 
                   
 
 

 
 
                
 
<!DOCTYPE html>
<!-- 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, shrink-to-fit=no"><title>Calculate the AIC for a column of an mmkin object — AIC.mmkin • mkin</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.5.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.5.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Calculate the AIC for a column of an mmkin object — AIC.mmkin"><meta name="description" content="Provides a convenient way to compare different kinetic models fitted to the
same dataset."><meta property="og:description" content="Provides a convenient way to compare different kinetic models fitted to the
same dataset."></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="default" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">mkin</a>

    <small class="nav-text text-default me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">1.2.9</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><a class="dropdown-item" href="../articles/mkin.html">Introduction to mkin</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Example evaluations with (generalised) nonlinear least squares</h6></li>
    <li><a class="dropdown-item" href="../articles/FOCUS_D.html">Example evaluation of FOCUS Example Dataset D</a></li>
    <li><a class="dropdown-item" href="../articles/FOCUS_L.html">Example evaluation of FOCUS Laboratory Data L1 to L3</a></li>
    <li><a class="dropdown-item" href="../articles/web_only/FOCUS_Z.html">Example evaluation of FOCUS Example Dataset Z</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Example evaluations with hierarchical models (nonlinear mixed-effects models)</h6></li>
    <li><a class="dropdown-item" href="../articles/prebuilt/2022_dmta_parent.html">Testing hierarchical parent degradation kinetics with residue data on dimethenamid and dimethenamid-P</a></li>
    <li><a class="dropdown-item" href="../articles/prebuilt/2022_dmta_pathway.html">Testing hierarchical pathway kinetics with residue data on dimethenamid and dimethenamid-P</a></li>
    <li><a class="dropdown-item" href="../articles/prebuilt/2023_mesotrione_parent.html">Testing covariate modelling in hierarchical parent degradation kinetics with residue data on mesotrione</a></li>
    <li><a class="dropdown-item" href="../articles/prebuilt/2022_cyan_pathway.html">Testing hierarchical pathway kinetics with residue data on cyantraniliprole</a></li>
    <li><a class="dropdown-item" href="../articles/web_only/dimethenamid_2018.html">Comparison of saemix and nlme evaluations of dimethenamid data from 2018</a></li>
    <li><a class="dropdown-item" href="../articles/web_only/multistart.html">Short demo of the multistart method</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Performance</h6></li>
    <li><a class="dropdown-item" href="../articles/web_only/compiled_models.html">Performance benefit by using compiled model definitions in mkin</a></li>
    <li><a class="dropdown-item" href="../articles/web_only/benchmarks.html">Benchmark timings for mkin</a></li>
    <li><a class="dropdown-item" href="../articles/web_only/saem_benchmarks.html">Benchmark timings for saem.mmkin</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Miscellaneous</h6></li>
    <li><a class="dropdown-item" href="../articles/twa.html">Calculation of time weighted average concentrations with mkin</a></li>
    <li><a class="dropdown-item" href="../articles/web_only/NAFTA_examples.html">Example evaluation of NAFTA SOP Attachment examples</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../coverage/coverage.html">Test coverage</a></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">News</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/jranke/mkin/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">

      <h1>Calculate the AIC for a column of an mmkin object</h1>
      <small class="dont-index">Source: <a href="https://github.com/jranke/mkin/blob/HEAD/R/AIC.mmkin.R" class="external-link"><code>R/AIC.mmkin.R</code></a></small>
      <div class="d-none name"><code>AIC.mmkin.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Provides a convenient way to compare different kinetic models fitted to the
same dataset.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co"># S3 method for class 'mmkin'</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">AIC</a></span><span class="op">(</span><span class="va">object</span>, <span class="va">...</span>, k <span class="op">=</span> <span class="fl">2</span><span class="op">)</span></span>
<span></span>
<span><span class="co"># S3 method for class 'mmkin'</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">BIC</a></span><span class="op">(</span><span class="va">object</span>, <span class="va">...</span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-object">object<a class="anchor" aria-label="anchor" href="#arg-object"></a></dt>
<dd><p>An object of class <code><a href="mmkin.html">mmkin</a></code>, containing only one
column.</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>For compatibility with the generic method</p></dd>


<dt id="arg-k">k<a class="anchor" aria-label="anchor" href="#arg-k"></a></dt>
<dd><p>As in the generic method</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>As in the generic method (a numeric value for single fits, or a
dataframe if there are several fits in the column).</p>
    </div>
    <div class="section level2">
    <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
    <p>Johannes Ranke</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span>
<span class="r-in"><span>   <span class="co"># skip, as it takes &gt; 10 s on winbuilder</span></span></span>
<span class="r-in"><span>  <span class="va">f</span> <span class="op">&lt;-</span> <span class="fu"><a href="mmkin.html">mmkin</a></span><span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</span><span class="st">"SFO"</span>, <span class="st">"FOMC"</span>, <span class="st">"DFOP"</span><span class="op">)</span>,</span></span>
<span class="r-in"><span>    <span class="fu"><a href="https://rdrr.io/r/base/list.html" class="external-link">list</a></span><span class="op">(</span><span class="st">"FOCUS A"</span> <span class="op">=</span> <span class="va">FOCUS_2006_A</span>,</span></span>
<span class="r-in"><span>         <span class="st">"FOCUS C"</span> <span class="op">=</span> <span class="va">FOCUS_2006_C</span><span class="op">)</span>, cores <span class="op">=</span> <span class="fl">1</span>, quiet <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> <span class="warning">Warning: </span>Optimisation did not converge:</span>
<span class="r-wrn co"><span class="r-pr">#&gt;</span> false convergence (8)</span>
<span class="r-in"><span>  <span class="co"># We get a warning because the FOMC model does not converge for the</span></span></span>
<span class="r-in"><span>  <span class="co"># FOCUS A dataset, as it is well described by SFO</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">AIC</a></span><span class="op">(</span><span class="va">f</span><span class="op">[</span><span class="st">"SFO"</span>, <span class="st">"FOCUS A"</span><span class="op">]</span><span class="op">)</span> <span class="co"># We get a single number for a single fit</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 55.28197</span>
<span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">AIC</a></span><span class="op">(</span><span class="va">f</span><span class="op">[[</span><span class="st">"SFO"</span>, <span class="st">"FOCUS A"</span><span class="op">]</span><span class="op">]</span><span class="op">)</span> <span class="co"># or when extracting an mkinfit object</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span> [1] 55.28197</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span>  <span class="co"># For FOCUS A, the models fit almost equally well, so the higher the number</span></span></span>
<span class="r-in"><span>  <span class="co"># of parameters, the higher (worse) the AIC</span></span></span>
<span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">AIC</a></span><span class="op">(</span><span class="va">f</span><span class="op">[</span>, <span class="st">"FOCUS A"</span><span class="op">]</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span>      df      AIC</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> SFO   3 55.28197</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> FOMC  4 57.28198</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> DFOP  5 59.28197</span>
<span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">AIC</a></span><span class="op">(</span><span class="va">f</span><span class="op">[</span>, <span class="st">"FOCUS A"</span><span class="op">]</span>, k <span class="op">=</span> <span class="fl">0</span><span class="op">)</span> <span class="co"># If we do not penalize additional parameters, we get nearly the same</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span>      df      AIC</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> SFO   3 49.28197</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> FOMC  4 49.28198</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> DFOP  5 49.28197</span>
<span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">BIC</a></span><span class="op">(</span><span class="va">f</span><span class="op">[</span>, <span class="st">"FOCUS A"</span><span class="op">]</span><span class="op">)</span>        <span class="co"># Comparing the BIC gives a very similar picture</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span>      df      BIC</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> SFO   3 55.52030</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> FOMC  4 57.59974</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> DFOP  5 59.67918</span>
<span class="r-in"><span></span></span>
<span class="r-in"><span>  <span class="co"># For FOCUS C, the more complex models fit better</span></span></span>
<span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">AIC</a></span><span class="op">(</span><span class="va">f</span><span class="op">[</span>, <span class="st">"FOCUS C"</span><span class="op">]</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span>      df      AIC</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> SFO   3 59.29336</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> FOMC  4 44.68652</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> DFOP  5 29.02372</span>
<span class="r-in"><span>  <span class="fu"><a href="https://rdrr.io/r/stats/AIC.html" class="external-link">BIC</a></span><span class="op">(</span><span class="va">f</span><span class="op">[</span>, <span class="st">"FOCUS C"</span><span class="op">]</span><span class="op">)</span></span></span>
<span class="r-out co"><span class="r-pr">#&gt;</span>      df      BIC</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> SFO   3 59.88504</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> FOMC  4 45.47542</span>
<span class="r-out co"><span class="r-pr">#&gt;</span> DFOP  5 30.00984</span>
<span class="r-in"><span>  </span></span>
<span class="r-in"><span></span></span>
</code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>Developed by Johannes Ranke.</p>
</div>

<div class="pkgdown-footer-right">
  <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.1.</p>
</div>

    </footer></div>





  </body></html>

Contact - Imprint