diff options
Diffstat (limited to 'docs/reference/TOXSWA_cwa.html')
| -rw-r--r-- | docs/reference/TOXSWA_cwa.html | 44 |
1 files changed, 21 insertions, 23 deletions
diff --git a/docs/reference/TOXSWA_cwa.html b/docs/reference/TOXSWA_cwa.html index 3f9310a..908f233 100644 --- a/docs/reference/TOXSWA_cwa.html +++ b/docs/reference/TOXSWA_cwa.html @@ -25,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> @@ -74,7 +76,7 @@ Usually, an instance of this class will be generated by <code><a href='read.TOXSWA_cwa.html'>read.TOXSWA_cwa</a></code>.</p> - <pre><span class='no'>TOXSWA_cwa</span></pre> + <pre class="usage"><span class='no'>TOXSWA_cwa</span></pre> <h2 class="hasAnchor" id="format"><a class="anchor" href="#format"></a>Format</h2> @@ -82,34 +84,30 @@ Usually, an instance of this class will be generated by <code><a href='read.TOXS <h2 class="hasAnchor" id="fields"><a class="anchor" href="#fields"></a>Fields</h2> - <p></p> - <p><dl class='dl-horizontal'> -<dt><code>filename</code></dt><dd>Length one character vector.</dd></p> - <p><dt><code>basedir</code></dt><dd>Length one character vector.</dd></p> - <p><dt><code>segment</code></dt><dd>Length one integer, specifying for which segment the cwa data were read.</dd></p> - <p><dt><code>cwas</code></dt><dd>Dataframe holding the concentrations.</dd></p> - <p><dt><code>events</code></dt><dd>List of dataframes holding the event statistics for each threshold.</dd></p> - <p><dt><code>windows</code></dt><dd>Matrix of maximum time weighted average concentrations (TWAC_max) + + <dl class='dl-horizontal'> +<dt><code>filename</code></dt><dd><p>Length one character vector.</p></dd> + <dt><code>basedir</code></dt><dd><p>Length one character vector.</p></dd> + <dt><code>segment</code></dt><dd><p>Length one integer, specifying for which segment the cwa data were read.</p></dd> + <dt><code>cwas</code></dt><dd><p>Dataframe holding the concentrations.</p></dd> + <dt><code>events</code></dt><dd><p>List of dataframes holding the event statistics for each threshold.</p></dd> + <dt><code>windows</code></dt><dd><p>Matrix of maximum time weighted average concentrations (TWAC_max) and areas under the curve in µg/day * h (AUC_max_h) or µg/day * d (AUC_max_d) -for the requested moving window sizes in days.</dd> -</dl></p> +for the requested moving window sizes in days.</p></dd> +</dl> <h2 class="hasAnchor" id="methods"><a class="anchor" href="#methods"></a>Methods</h2> - <p></p> - <p><dl class='dl-horizontal'> - <dt><code>get_events(threshold, total = FALSE)</code></dt><dd> - Populate a datataframe with event information for the specified threshold value + + <dl class='dl-horizontal'> + <dt><code>get_events(threshold, total = FALSE)</code></dt><dd><p>Populate a datataframe with event information for the specified threshold value in µg/L. If <code>total = TRUE</code>, the total concentration including the amount adsorbed to suspended matter will be used. The resulting dataframe is stored in the - <code>events</code> field of the object. - </dd> - <dt><code>moving_windows(windows, total = FALSE)</code></dt><dd> - Add to the <code>windows</code> field described above. + <code>events</code> field of the object.</p></dd> + <dt><code>moving_windows(windows, total = FALSE)</code></dt><dd><p>Add to the <code>windows</code> field described above. Again, if <code>total = TRUE</code>, the total concentration including the amount - adsorbed to suspended matter will be used. - </dd> -</dl></p> + adsorbed to suspended matter will be used.</p></dd> +</dl> <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> |