aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/max_twa_parent.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2019-10-25 02:10:08 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2019-10-25 02:10:08 +0200
commitaf2e1540cdad2fd00bb6216a38a754ff748629ad (patch)
tree9ec5d1ff3050c9fa826636536fc60dbda9edb1e4 /docs/reference/max_twa_parent.html
parent0a3eb0893cb4bd1b12f07a79069d1c7f5e991495 (diff)
Static documentation rebuilt by pkgdown
Diffstat (limited to 'docs/reference/max_twa_parent.html')
-rw-r--r--docs/reference/max_twa_parent.html83
1 files changed, 44 insertions, 39 deletions
diff --git a/docs/reference/max_twa_parent.html b/docs/reference/max_twa_parent.html
index d1c2a805..ef2a55bf 100644
--- a/docs/reference/max_twa_parent.html
+++ b/docs/reference/max_twa_parent.html
@@ -6,13 +6,16 @@
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit — max_twa_parent • mkin</title>
+<title>Function to calculate maximum time weighted average concentrations from
+kinetic models fitted with mkinfit — max_twa_parent • 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,17 +35,19 @@
-<meta property="og:title" content="Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit — max_twa_parent" />
-<meta property="og:description" content="This function calculates maximum moving window time weighted average concentrations
-(TWAs) for kinetic models fitted with mkinfit. Currently, only
-calculations for the parent are implemented for the SFO, FOMC, DFOP and HS models,
-using the analytical formulas given in the PEC soil section of the FOCUS
-guidance." />
+<meta property="og:title" content="Function to calculate maximum time weighted average concentrations from
+kinetic models fitted with mkinfit — max_twa_parent" />
+<meta property="og:description" content="This function calculates maximum moving window time weighted average
+concentrations (TWAs) for kinetic models fitted with mkinfit.
+Currently, only calculations for the parent are implemented for the SFO,
+FOMC, DFOP and HS models, using the analytical formulas given in the PEC
+soil section of the FOCUS guidance." />
<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>
@@ -113,7 +118,6 @@ guidance." />
<a href="../news/index.html">News</a>
</li>
</ul>
-
<ul class="nav navbar-nav navbar-right">
</ul>
@@ -129,27 +133,30 @@ guidance." />
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
- <h1>Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit</h1>
+ <h1>Function to calculate maximum time weighted average concentrations from
+kinetic models fitted with mkinfit</h1>
<div class="hidden name"><code>max_twa_parent.Rd</code></div>
</div>
<div class="ref-description">
-
- <p>This function calculates maximum moving window time weighted average concentrations
-(TWAs) for kinetic models fitted with <code><a href='mkinfit.html'>mkinfit</a></code>. Currently, only
-calculations for the parent are implemented for the SFO, FOMC, DFOP and HS models,
-using the analytical formulas given in the PEC soil section of the FOCUS
-guidance.</p>
-
+ <p>This function calculates maximum moving window time weighted average
+concentrations (TWAs) for kinetic models fitted with <code><a href='mkinfit.html'>mkinfit</a></code>.
+Currently, only calculations for the parent are implemented for the SFO,
+FOMC, DFOP and HS models, using the analytical formulas given in the PEC
+soil section of the FOCUS guidance.</p>
</div>
<pre class="usage"><span class='fu'>max_twa_parent</span>(<span class='no'>fit</span>, <span class='no'>windows</span>)
- <span class='fu'>max_twa_sfo</span>(<span class='kw'>M0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>k</span>, <span class='no'>t</span>)
- <span class='fu'>max_twa_fomc</span>(<span class='kw'>M0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>alpha</span>, <span class='no'>beta</span>, <span class='no'>t</span>)
- <span class='fu'>max_twa_dfop</span>(<span class='kw'>M0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>k1</span>, <span class='no'>k2</span>, <span class='no'>g</span>, <span class='no'>t</span>)
- <span class='fu'>max_twa_hs</span>(<span class='kw'>M0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>k1</span>, <span class='no'>k2</span>, <span class='no'>tb</span>, <span class='no'>t</span>)</pre>
-
+
+<span class='fu'>max_twa_sfo</span>(<span class='kw'>M0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>k</span>, <span class='no'>t</span>)
+
+<span class='fu'>max_twa_fomc</span>(<span class='kw'>M0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>alpha</span>, <span class='no'>beta</span>, <span class='no'>t</span>)
+
+<span class='fu'>max_twa_dfop</span>(<span class='kw'>M0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>k1</span>, <span class='no'>k2</span>, <span class='no'>g</span>, <span class='no'>t</span>)
+
+<span class='fu'>max_twa_hs</span>(<span class='kw'>M0</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='no'>k1</span>, <span class='no'>k2</span>, <span class='no'>tb</span>, <span class='no'>t</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>
@@ -159,14 +166,15 @@ guidance.</p>
</tr>
<tr>
<th>windows</th>
- <td><p>The width of the time windows for which the TWAs should be calculated.</p></td>
+ <td><p>The width of the time windows for which the TWAs should be
+calculated.</p></td>
</tr>
<tr>
<th>M0</th>
<td><p>The initial concentration for which the maximum time weighted
- average over the decline curve should be calculated. The default
- is to use a value of 1, which means that a relative maximum time
- weighted average factor (f_twa) is calculated.</p></td>
+average over the decline curve should be calculated. The default is to use
+a value of 1, which means that a relative maximum time weighted average
+factor (f_twa) is calculated.</p></td>
</tr>
<tr>
<th>k</th>
@@ -201,36 +209,33 @@ guidance.</p>
<td><p>Parameter of the HS model.</p></td>
</tr>
</table>
-
+
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
- <p>For <code>max_twa_parent</code>, a numeric vector, named using the <code>windows</code> argument.
- For the other functions, a numeric vector of length one (also known as 'a
- number').</p>
-
+ <p>For <code>max_twa_parent</code>, a numeric vector, named using the
+ <code>windows</code> argument. For the other functions, a numeric vector of
+ length one (also known as 'a number').</p>
<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,
+ <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='no'>fit</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='st'>"FOMC"</span>, <span class='no'>FOCUS_2006_C</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
+ <pre class="examples"><div class='input'>
+ <span class='no'>fit</span> <span class='kw'>&lt;-</span> <span class='fu'><a href='mkinfit.html'>mkinfit</a></span>(<span class='st'>"FOMC"</span>, <span class='no'>FOCUS_2006_C</span>, <span class='kw'>quiet</span> <span class='kw'>=</span> <span class='fl'>TRUE</span>)
<span class='fu'>max_twa_parent</span>(<span class='no'>fit</span>, <span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>7</span>, <span class='fl'>21</span>))</div><div class='output co'>#&gt; 7 21
-#&gt; 34.71343 18.22124 </div></pre>
+#&gt; 34.71343 18.22124 </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>

Contact - Imprint