diff options
Diffstat (limited to 'docs/reference/add_err.html')
| -rw-r--r-- | docs/reference/add_err.html | 82 |
1 files changed, 43 insertions, 39 deletions
diff --git a/docs/reference/add_err.html b/docs/reference/add_err.html index aab42f56..c9e6bf3f 100644 --- a/docs/reference/add_err.html +++ b/docs/reference/add_err.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> - — add_err • mkin</title> +<title>Add normally distributed errors to simulated kinetic degradation data — add_err • 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>Add normally distributed errors to simulated kinetic degradation data</h1> </div> @@ -106,45 +109,46 @@ may depend on the predicted value and is specified as a standard deviation.</p> - <pre><span class='fu'>add_err</span>(<span class='no'>prediction</span>, <span class='no'>sdfunc</span>, + <pre class="usage"><span class='fu'>add_err</span>(<span class='no'>prediction</span>, <span class='no'>sdfunc</span>, <span class='kw'>n</span> <span class='kw'>=</span> <span class='fl'>1000</span>, <span class='kw'>LOD</span> <span class='kw'>=</span> <span class='fl'>0.1</span>, <span class='kw'>reps</span> <span class='kw'>=</span> <span class='fl'>2</span>, <span class='kw'>digits</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>seed</span> <span class='kw'>=</span> <span class='fl'>NA</span>)</pre> <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2> - <dl class="dl-horizontal"> - <dt>prediction</dt> - <dd> - A prediction from a kinetic model as produced by <code><a href='mkinpredict.html'>mkinpredict</a></code>. - </dd> - <dt>sdfunc</dt> - <dd> - A function taking the predicted value as its only argument and returning + <table class="ref-arguments"> + <colgroup><col class="name" /><col class="desc" /></colgroup> + <tr> + <th>prediction</th> + <td><p>A prediction from a kinetic model as produced by <code><a href='mkinpredict.html'>mkinpredict</a></code>.</p></td> + </tr> + <tr> + <th>sdfunc</th> + <td><p>A function taking the predicted value as its only argument and returning a standard deviation that should be used for generating the random error - terms for this value. - </dd> - <dt>n</dt> - <dd> - The number of datasets to be generated. - </dd> - <dt>LOD</dt> - <dd> - The limit of detection (LOD). Values that are below the LOD after adding - the random error will be set to NA. - </dd> - <dt>reps</dt> - <dd> - The number of replicates to be generated within the datasets. - </dd> - <dt>digits</dt> - <dd> - The number of digits to which the values will be rounded. - </dd> - <dt>seed</dt> - <dd> - The seed used for the generation of random numbers. If NA, the seed - is not set. - </dd> - </dl> + terms for this value.</p></td> + </tr> + <tr> + <th>n</th> + <td><p>The number of datasets to be generated.</p></td> + </tr> + <tr> + <th>LOD</th> + <td><p>The limit of detection (LOD). Values that are below the LOD after adding + the random error will be set to NA.</p></td> + </tr> + <tr> + <th>reps</th> + <td><p>The number of replicates to be generated within the datasets.</p></td> + </tr> + <tr> + <th>digits</th> + <td><p>The number of digits to which the values will be rounded.</p></td> + </tr> + <tr> + <th>seed</th> + <td><p>The seed used for the generation of random numbers. If NA, the seed + is not set.</p></td> + </tr> + </table> <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2> |