aboutsummaryrefslogtreecommitdiff
path: root/docs/reference/read.TOXSWA_cwa.html
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-01-18 22:41:01 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2017-01-18 22:50:14 +0100
commita76221d87485029444c8e684022ca606a0c7e68d (patch)
treec95052ee51b35f6c5ab87bd6f27ef2877f536838 /docs/reference/read.TOXSWA_cwa.html
parenta1d9f93138c2cfed92a683e37e72c737d52b7ad7 (diff)
Update static docs using pkgdown
- Add _pkgdown.yml for a structured function/data reference - Make seealso links active - Make mkinfit calls quiet - Use pkgdown branch from pull request hadley/pkgdown#229 to have topics ordered
Diffstat (limited to 'docs/reference/read.TOXSWA_cwa.html')
-rw-r--r--docs/reference/read.TOXSWA_cwa.html154
1 files changed, 154 insertions, 0 deletions
diff --git a/docs/reference/read.TOXSWA_cwa.html b/docs/reference/read.TOXSWA_cwa.html
new file mode 100644
index 0000000..3afec9c
--- /dev/null
+++ b/docs/reference/read.TOXSWA_cwa.html
@@ -0,0 +1,154 @@
+<!-- Generated by pkgdown: do not edit by hand -->
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+<title>Read TOXSWA surface water concentrations — read.TOXSWA_cwa • pfm</title>
+
+<!-- jquery -->
+<script src="https://code.jquery.com/jquery-3.1.0.min.js" integrity="sha384-nrOSfDHtoPMzJHjVTdCopGqIqeYETSXhZDFyniQ8ZHcVy08QesyHcnOUpMpqnmWq" crossorigin="anonymous"></script>
+<!-- Bootstrap -->
+
+<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
+<script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
+
+<!-- Font Awesome icons -->
+<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-T8Gy5hrqNKT+hzMclPo118YTQO6cYprQmhrYwIiQ/3axmI1hQomh7Ud2hPOy8SP1" crossorigin="anonymous">
+
+
+<!-- pkgdown -->
+<link href="../pkgdown.css" rel="stylesheet">
+<script src="../jquery.sticky-kit.min.js"></script>
+<script src="../pkgdown.js"></script>
+
+<!-- mathjax -->
+<script src='https://cdn.mathjax.org/mathjax/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>
+ <div class="container template-reference-topic">
+ <header>
+ <div class="navbar navbar-default navbar-fixed-top" role="navigation">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="../index.html">pfm</a>
+ </div>
+ <div id="navbar" class="navbar-collapse collapse">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="../reference/index.html">Reference</a>
+</li>
+ </ul>
+
+ <ul class="nav navbar-nav navbar-right">
+
+ </ul>
+ </div><!--/.nav-collapse -->
+ </div><!--/.container -->
+</div><!--/.navbar -->
+
+
+ </header>
+
+ <div class="row">
+ <div class="col-md-9 contents">
+ <div class="page-header">
+ <h1>Read TOXSWA surface water concentrations</h1>
+ </div>
+
+
+ <p>Read TOXSWA hourly concentrations of a chemical substance in a specific
+segment of a TOXSWA surface water body. Per default, the data for the last
+segment are imported. As TOXSWA 4 reports the values at the end of the hour
+(ConLiqWatLayCur) in its summary file, we use this value as well instead
+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>,
+ <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
+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
+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>
+
+ <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
+
+ <p>An instance of an R6 object of class
+<code><a href='TOXSWA_cwa.html'>TOXSWA_cwa</a></code>.</p>
+
+
+ <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
+ <pre class="examples"><div class='input'><span class='no'>H_sw_D4_pond</span> <span class='kw'>&lt;-</span> <span class='fu'>read.TOXSWA_cwa</span>(<span class='st'>"00001p_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'>system.file</span>(<span class='st'>"testdata/SwashProjects.zip"</span>,
+ <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"pfm"</span>))</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="#examples">Examples</a></li>
+ </ul>
+
+ <h2>Author</h2>
+
+Johannes Ranke
+
+ </div>
+</div>
+
+ <footer>
+ <div class="copyright">
+ <p>Developed by Johannes Ranke.</p>
+</div>
+
+<div class="pkgdown">
+ <p>Site built with <a href="http://hadley.github.io/pkgdown/">pkgdown</a>.</p>
+</div>
+
+ </footer>
+ </div>
+
+ </body>
+</html>

Contact - Imprint