diff options
| author | Johannes Ranke <jranke@uni-bremen.de> | 2019-09-18 18:18:40 +0200 |
|---|---|---|
| committer | Johannes Ranke <jranke@uni-bremen.de> | 2019-09-18 18:18:40 +0200 |
| commit | 803fe13e505960fddccdbd4dcb524715f5eb068d (patch) | |
| tree | be5a3b2ca52e20b3bfae758299febf15c889d621 /docs/reference/TOXSWA_cwa.html | |
| parent | 8deaa29a659630a40e8b11df1fa3ebbbd9ca9e68 (diff) | |
Add url: tag to _pkgdown.yml, typo, update docs
Diffstat (limited to 'docs/reference/TOXSWA_cwa.html')
| -rw-r--r-- | docs/reference/TOXSWA_cwa.html | 59 |
1 files changed, 36 insertions, 23 deletions
diff --git a/docs/reference/TOXSWA_cwa.html b/docs/reference/TOXSWA_cwa.html index d840e52..ab741ae 100644 --- a/docs/reference/TOXSWA_cwa.html +++ b/docs/reference/TOXSWA_cwa.html @@ -16,13 +16,15 @@ <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 --> -<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css" integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" /> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/all.min.css" integrity="sha256-nAmazAk6vS34Xqo0BSrTb+abbtFlgsFK7NKSi6o7Y78=" crossorigin="anonymous" /> +<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.7.1/css/v4-shims.min.css" integrity="sha256-6qHlizsOWFskGlwVOKuns+D1nB6ssZrHQrNj1wGplHc=" crossorigin="anonymous" /> <!-- clipboard.js --> <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.4/clipboard.min.js" integrity="sha256-FiZwavyI2V6+EXO1U+xzLG3IKldpiTFf3153ea9zikQ=" crossorigin="anonymous"></script> -<!-- sticky kit --> -<script src="https://cdnjs.cloudflare.com/ajax/libs/sticky-kit/1.1.3/sticky-kit.min.js" integrity="sha256-c4Rlo1ZozqTPE2RLuvbusY3+SU1pQaJC0TjuhygMipw=" crossorigin="anonymous"></script> +<!-- headroom.js --> +<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/headroom.min.js" integrity="sha256-DJFC1kqIhelURkuza0AvYal5RxMtpzLjFhsnVIeuk+U=" crossorigin="anonymous"></script> +<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.9.4/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script> <!-- pkgdown --> <link href="../pkgdown.css" rel="stylesheet"> @@ -48,6 +50,7 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." /> <![endif]--> + </head> <body> @@ -72,7 +75,7 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." /> <ul class="nav navbar-nav"> <li> <a href="../index.html"> - <span class="fa fa-home fa-lg"></span> + <span class="fas fa fas fa-home fa-lg"></span> </a> </li> @@ -82,12 +85,7 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." /> </ul> <ul class="nav navbar-nav navbar-right"> - <li> - <a href="https://github.com/jranke/pfm"> - <span class="fa fa-github fa-lg"></span> - - </a> -</li> + </ul> </div><!--/.nav-collapse --> @@ -95,13 +93,14 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." /> </div><!--/.navbar --> + </header> <div class="row"> <div class="col-md-9 contents"> <div class="page-header"> <h1>R6 class for holding TOXSWA water concentration data and associated statistics</h1> - <small class="dont-index">Source: <a href='https://github.com/jranke/pfm/blob/master/R/TOXSWA_cwa.R'><code>R/TOXSWA_cwa.R</code></a></small> + <div class="hidden name"><code>TOXSWA_cwa.Rd</code></div> </div> @@ -121,21 +120,29 @@ 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> - <dl class='dl-horizontal'> + +<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) + +<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.</p></dd> + </dl> <h2 class="hasAnchor" id="methods"><a class="anchor" href="#methods"></a>Methods</h2> - <dl class='dl-horizontal'> + +<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 @@ -143,17 +150,19 @@ for the requested moving window sizes in days.</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.</p></dd> + </dl> + <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2> <pre class="examples"><div class='input'><span class='no'>H_sw_R1_stream</span> <span class='kw'><-</span> <span class='fu'><a href='read.TOXSWA_cwa.html'>read.TOXSWA_cwa</a></span>(<span class='st'>"00003s_pa.cwa"</span>, <span class='kw'>basedir</span> <span class='kw'>=</span> <span class='st'>"SwashProjects/project_H_sw/TOXSWA"</span>, - <span class='kw'>zipfile</span> <span class='kw'>=</span> <span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/system.file'>system.file</a></span>(<span class='st'>"testdata/SwashProjects.zip"</span>, + <span class='kw'>zipfile</span> <span class='kw'>=</span> <span class='fu'><a href='https://rdrr.io/r/base/system.file.html'>system.file</a></span>(<span class='st'>"testdata/SwashProjects.zip"</span>, <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"pfm"</span>)) -<span class='no'>H_sw_R1_stream</span>$<span class='fu'>get_events</span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(<span class='fl'>2</span>, <span class='fl'>10</span>)) -<span class='no'>H_sw_R1_stream</span>$<span class='fu'>moving_windows</span>(<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/c'>c</a></span>(<span class='fl'>7</span>, <span class='fl'>21</span>)) -<span class='fu'><a href='https://www.rdocumentation.org/packages/base/topics/print'>print</a></span>(<span class='no'>H_sw_R1_stream</span>)</div><div class='output co'>#> <TOXSWA_cwa> data from file 00003s_pa.cwa segment 20 +<span class='no'>H_sw_R1_stream</span>$<span class='fu'>get_events</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>2</span>, <span class='fl'>10</span>)) +<span class='no'>H_sw_R1_stream</span>$<span class='fu'>moving_windows</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>)) +<span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span>(<span class='no'>H_sw_R1_stream</span>)</div><div class='output co'>#> <TOXSWA_cwa> data from file 00003s_pa.cwa segment 20 #> datetime t t_firstjan t_rel_to_max cwa_mug_per_L #> 20 1978-10-01 00:00:00 0.000 273.0000 -55.333 0 #> 40 1978-10-01 01:00:00 0.042 273.0417 -55.291 0 @@ -196,19 +205,23 @@ for the requested moving window sizes in days.</p></dd> </div> </div> + <footer> <div class="copyright"> <p>Developed by Johannes Ranke.</p> </div> <div class="pkgdown"> - <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.3.0.</p> + <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.4.1.</p> </div> + </footer> </div> + </body> </html> + |