diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2019-10-25 02:10:08 +0200 | 
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2019-10-25 02:10:08 +0200 | 
| commit | af2e1540cdad2fd00bb6216a38a754ff748629ad (patch) | |
| tree | 9ec5d1ff3050c9fa826636536fc60dbda9edb1e4 /docs/reference/add_err.html | |
| parent | 0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 (diff) | |
Static documentation rebuilt by pkgdown
Diffstat (limited to 'docs/reference/add_err.html')
| -rw-r--r-- | docs/reference/add_err.html | 65 | 
1 files changed, 32 insertions, 33 deletions
| diff --git a/docs/reference/add_err.html b/docs/reference/add_err.html index eeaf9e5b..67789694 100644 --- a/docs/reference/add_err.html +++ b/docs/reference/add_err.html @@ -8,11 +8,13 @@  <title>Add normally distributed errors to simulated kinetic degradation data — add_err • mkin</title> +  <!-- jquery -->  <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.3.1/jquery.min.js" integrity="sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8=" crossorigin="anonymous"></script>  <!-- Bootstrap -->  <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha256-916EbMg70RQy9LHiGkXzG8hSg9EdNy97GazNG/aiY1w=" crossorigin="anonymous" /> +  <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha256-U5ZEeKfGNOja007MMD3YBI0A3OSZOQbeG6z2f2Y0hu8=" crossorigin="anonymous"></script>  <!-- Font Awesome icons --> @@ -32,15 +34,16 @@ -<meta property="og:title" content="Add normally distributed errors to simulated kinetic degradation data — add_err" /> +<meta property="og:title" content="Add normally distributed errors to simulated kinetic degradation data — add_err" />  <meta property="og:description" content="Normally distributed errors are added to data predicted for a specific -  degradation model using mkinpredict. The variance of the error -  may depend on the predicted value and is specified as a standard deviation." /> +degradation model using mkinpredict. The variance of the error +may depend on the predicted value and is specified as a standard deviation." />  <meta name="twitter:card" content="summary" /> +  <!-- mathjax -->  <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>  <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script> @@ -111,7 +114,6 @@    <a href="../news/index.html">News</a>  </li>        </ul> -              <ul class="nav navbar-nav navbar-right">        </ul> @@ -133,33 +135,32 @@      </div>      <div class="ref-description"> -          <p>Normally distributed errors are added to data predicted for a specific -  degradation model using <code><a href='mkinpredict.html'>mkinpredict</a></code>. The variance of the error -  may depend on the predicted value and is specified as a standard deviation.</p> -     +degradation model using <code><a href='mkinpredict.html'>mkinpredict</a></code>. The variance of the error +may depend on the predicted value and is specified as a standard deviation.</p>      </div> -    <pre class="usage"><span class='fu'>add_err</span>(<span class='no'>prediction</span>, <span class='no'>sdfunc</span>, <span class='kw'>secondary</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"M1"</span>, <span class='st'>"M2"</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> -     +    <pre class="usage"><span class='fu'>add_err</span>(<span class='no'>prediction</span>, <span class='no'>sdfunc</span>, <span class='kw'>secondary</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='st'>"M1"</span>, <span class='st'>"M2"</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>      <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> +      <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.</p></td> +      <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.</p></td>      </tr>      <tr>        <th>secondary</th> -      <td><p>The names of state variables that should have an initial value of zero</p></td> +      <td><p>The names of state variables that should have an initial +value of zero</p></td>      </tr>      <tr>        <th>n</th> @@ -167,8 +168,8 @@      </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> +      <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> @@ -180,25 +181,25 @@      </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> +      <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> -    <p>A list of datasets compatible with <code><a href='mmkin.html'>mmkin</a></code>, i.e. -  the components of the list are datasets compatible with -  <code><a href='mkinfit.html'>mkinfit</a></code>.</p> -     +    <p>A list of datasets compatible with <code><a href='mmkin.html'>mmkin</a></code>, i.e. the +  components of the list are datasets compatible with <code><a href='mkinfit.html'>mkinfit</a></code>.</p>      <h2 class="hasAnchor" id="references"><a class="anchor" href="#references"></a>References</h2> -    <p>Ranke J and Lehmann R (2015) To t-test or not to t-test, that is the question. XV Symposium on Pesticide Chemistry 2-4 September 2015, Piacenza, Italy -  http://chem.uft.uni-bremen.de/ranke/posters/piacenza_2015.pdf</p> -     +    <p>Ranke J and Lehmann R (2015) To t-test or not to t-test, that is +the question. XV Symposium on Pesticide Chemistry 2-4 September 2015, +Piacenza, Italy +http://chem.uft.uni-bremen.de/ranke/posters/piacenza_2015.pdf</p>      <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> -    <pre class="examples"><div class='input'><span class='co'># The kinetic model</span> +    <pre class="examples"><div class='input'> +<span class='co'># The kinetic model</span>  <span class='no'>m_SFO_SFO</span> <span class='kw'><-</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='st'>"M1"</span>),                       <span class='kw'>M1</span> <span class='kw'>=</span> <span class='fu'><a href='mkinsub.html'>mkinsub</a></span>(<span class='st'>"SFO"</span>), <span class='kw'>use_of_ff</span> <span class='kw'>=</span> <span class='st'>"max"</span>)</div><div class='output co'>#> <span class='message'>Successfully compiled differential equation model from auto-generated C code.</span></div><div class='input'>  <span class='co'># Generate a prediction for a specific set of parameters</span> @@ -235,17 +236,15 @@  <span class='co'># If we use single brackets, we should give two indices (model and dataset),</span>  <span class='co'># and plot.mmkin is used</span>  <span class='fu'><a href='https://rdrr.io/r/graphics/plot.html'>plot</a></span>(<span class='no'>f_SFO_SFO</span>[<span class='fl'>1</span>, <span class='fl'>3</span>])</div><div class='img'><img src='add_err-3.png' alt='' width='700' height='433' /></div><div class='input'># } +  </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> | 
