aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/read.TOXSWA_cwa.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-05-16 15:43:50 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2017-05-16 15:43:50 +0200
commit36036b5901223591e7e21e8b73d8cd1fb034f4cb (patch)
treeed8e764778aa2e94b785263d18d7d8e3dfe4e785 /docs/reference/read.TOXSWA_cwa.html
parentd042f8f06b313e8595087587455daac73d84f17b (diff)
Finish the Step 1 calculator including tests
Some cleaning up. PELMO facilities do not currently work at my end, as I have no working wine installation on this computer
Diffstat (limited to 'docs/reference/read.TOXSWA_cwa.html')
-rw-r--r--docs/reference/read.TOXSWA_cwa.html71
1 files changed, 45 insertions, 26 deletions
diff --git a/docs/reference/read.TOXSWA_cwa.html b/docs/reference/read.TOXSWA_cwa.html
index 3afec9c..30e29cd 100644
--- a/docs/reference/read.TOXSWA_cwa.html
+++ b/docs/reference/read.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>
@@ -77,37 +79,54 @@ segment are imported. As TOXSWA 4 reports the values at the end of the hour
of the hourly averages (ConLiqWatLay).</p>
- <pre><span class='fu'>read.TOXSWA_cwa</span>(<span class='no'>filename</span>, <span class='kw'>basedir</span> <span class='kw'>=</span> <span class='st'>"."</span>, <span class='kw'>zipfile</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>segment</span> <span class='kw'>=</span> <span class='st'>"last"</span>,
+ <pre class="usage"><span class='fu'>read.TOXSWA_cwa</span>(<span class='no'>filename</span>, <span class='kw'>basedir</span> <span class='kw'>=</span> <span class='st'>"."</span>, <span class='kw'>zipfile</span> <span class='kw'>=</span> <span class='kw'>NULL</span>, <span class='kw'>segment</span> <span class='kw'>=</span> <span class='st'>"last"</span>,
<span class='kw'>substance</span> <span class='kw'>=</span> <span class='st'>"parent"</span>, <span class='kw'>total</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>windows</span> <span class='kw'>=</span> <span class='kw'>NULL</span>,
<span class='kw'>thresholds</span> <span class='kw'>=</span> <span class='kw'>NULL</span>)</pre>
<h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a> Arguments</h2>
- <dl class="dl-horizontal">
- <dt>filename</dt>
- <dd>The filename of the cwa file (TOXSWA 2.x.y or similar) or the
-out file (FOCUS TOXSWA 4, i.e. TOXSWA 4.4.2 or similar).</dd>
- <dt>basedir</dt>
- <dd>The path to the directory where the cwa file resides.</dd>
- <dt>zipfile</dt>
- <dd>Optional path to a zip file containing the cwa file.</dd>
- <dt>segment</dt>
- <dd>The segment for which the data should be read. Either &quot;last&quot;, or
-the segment number.</dd>
- <dt>substance</dt>
- <dd>For TOXSWA 4 .out files, the default value &quot;parent&quot; leads
+ <table class="ref-arguments">
+ <colgroup><col class="name" /><col class="desc" /></colgroup>
+ <tr>
+ <th>filename</th>
+ <td><p>The filename of the cwa file (TOXSWA 2.x.y or similar) or the
+out file (FOCUS TOXSWA 4, i.e. TOXSWA 4.4.2 or similar).</p></td>
+ </tr>
+ <tr>
+ <th>basedir</th>
+ <td><p>The path to the directory where the cwa file resides.</p></td>
+ </tr>
+ <tr>
+ <th>zipfile</th>
+ <td><p>Optional path to a zip file containing the cwa file.</p></td>
+ </tr>
+ <tr>
+ <th>segment</th>
+ <td><p>The segment for which the data should be read. Either "last", or
+the segment number.</p></td>
+ </tr>
+ <tr>
+ <th>substance</th>
+ <td><p>For TOXSWA 4 .out files, the default value "parent" leads
to reading concentrations of the parent compound. Alternatively, the substance
-of interested can be selected by its code name.</dd>
- <dt>total</dt>
- <dd>Set this to TRUE in order to read total concentrations as well. This is
+of interested can be selected by its code name.</p></td>
+ </tr>
+ <tr>
+ <th>total</th>
+ <td><p>Set this to TRUE in order to read total concentrations as well. This is
only necessary for .out files as generated by TOXSWA 4.4.2 or similar, not for .cwa
-files. For .cwa files, the total concentration is always read as well.</dd>
- <dt>windows</dt>
- <dd>Numeric vector of width of moving windows in days, for calculating
-maximum time weighted average concentrations and areas under the curve.</dd>
- <dt>thresholds</dt>
- <dd>Numeric vector of threshold concentrations in µg/L for
-generating event statistics.</dd>
- </dl>
+files. For .cwa files, the total concentration is always read as well.</p></td>
+ </tr>
+ <tr>
+ <th>windows</th>
+ <td><p>Numeric vector of width of moving windows in days, for calculating
+maximum time weighted average concentrations and areas under the curve.</p></td>
+ </tr>
+ <tr>
+ <th>thresholds</th>
+ <td><p>Numeric vector of threshold concentrations in µg/L for
+generating event statistics.</p></td>
+ </tr>
+ </table>
<h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>

Contact - Imprint