diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2017-05-05 12:46:31 +0200 | 
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2017-05-05 12:46:31 +0200 | 
| commit | ccc70e82af4ba435f0a71ba1ae4e0e92045c3852 (patch) | |
| tree | d8ffd99be771f47eae876f244b049742481bdd25 /docs/reference/mkinerrmin.html | |
| parent | 1c7dbeec335c404377381157d34db6e219ce3f21 (diff) | |
Static docs except articles rebuilt with current pkgdown
Diffstat (limited to 'docs/reference/mkinerrmin.html')
| -rw-r--r-- | docs/reference/mkinerrmin.html | 49 | 
1 files changed, 30 insertions, 19 deletions
| diff --git a/docs/reference/mkinerrmin.html b/docs/reference/mkinerrmin.html index 97616a41..678750cd 100644 --- a/docs/reference/mkinerrmin.html +++ b/docs/reference/mkinerrmin.html @@ -6,8 +6,7 @@  <meta http-equiv="X-UA-Compatible" content="IE=edge">  <meta name="viewport" content="width=device-width, initial-scale=1.0"> -<title> - — mkinerrmin • mkin</title> +<title>Calculate the minimum error to assume in order to pass the variance test — mkinerrmin • mkin</title>  <!-- jquery -->  <script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script> @@ -26,12 +25,14 @@  <script src="../pkgdown.js"></script>  <!-- mathjax --> -<script src='https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML'></script> +<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> @@ -71,6 +72,9 @@      <li>        <a href="../articles/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> @@ -96,8 +100,7 @@        <div class="row">    <div class="col-md-9 contents">      <div class="page-header"> -    <h1> -</h1> +    <h1>Calculate the minimum error to assume in order to pass the variance test</h1>      </div> @@ -105,25 +108,33 @@  chi-squared test as defined in the FOCUS kinetics report from 2006.</p> -    <pre><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> +    <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> -    <dl class="dl-horizontal"> -      <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> +    <table class="ref-arguments"> +    <colgroup><col class="name" /><col class="desc" /></colgroup> +    <tr> +      <th>fit</th> +      <td><p>an object of class <code><a href='mkinfit.html'>mkinfit</a></code>.</p></td> +    </tr> +    <tr> +      <th>alpha</th> +      <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> -    <p>The dataframe has one row for the total dataset and one further row for -  each observed state variable in the model.</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. +      <h2 class="hasAnchor" id="details"><a class="anchor" href="#details"></a>Details</h2> @@ -135,7 +146,7 @@ chi-squared test as defined in the FOCUS kinetics report from 2006.</p>    Degradation Kinetics from Environmental Fate Studies on Pesticides in EU    Registration” 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> +  <a href = 'http://esdac.jrc.europa.eu/projects/degradation-kinetics'>http://esdac.jrc.europa.eu/projects/degradation-kinetics</a></p>      <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> | 
