|
|
<!-- 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>Plot TOXSWA surface water concentrations — plot.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">
<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/1.7.1/clipboard.min.js" integrity="sha384-cV+rhyOuRHc9Ub/91rihWcGmMmCXDeksTtCihMupQHSsi8GIIRDG0ThDc3HGQFJ3" 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>
<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>
<meta property="og:title" content="Plot TOXSWA surface water concentrations — plot.TOXSWA_cwa" />
<meta property="og:description" content="Plot TOXSWA hourly concentrations of a chemical substance in a specific
segment of a TOXSWA surface water body." />
<meta name="twitter:card" content="summary" />
<!-- mathjax -->
<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>
<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>
<span class="navbar-brand">
<a class="navbar-link" href="../index.html">pfm</a>
<span class="label label-default" data-toggle="tooltip" data-placement="bottom" title="Released package">0.5.1</span>
</span>
</div>
<div id="navbar" class="navbar-collapse collapse">
<ul class="nav navbar-nav">
<li>
<a href="../index.html">
<span class="fa fa-home fa-lg"></span>
</a>
</li>
<li>
<a href="../reference/index.html">Reference</a>
</li>
</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 -->
</div><!--/.container -->
</div><!--/.navbar -->
</header>
<div class="row">
<div class="col-md-9 contents">
<div class="page-header">
<h1>Plot TOXSWA surface water concentrations</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>plot.TOXSWA_cwa.Rd</code></div>
</div>
<div class="ref-description">
<p>Plot TOXSWA hourly concentrations of a chemical substance in a specific
segment of a TOXSWA surface water body.</p>
</div>
<pre class="usage"><span class='co'># S3 method for TOXSWA_cwa</span>
<span class='fu'>plot</span>(<span class='no'>x</span>, <span class='kw'>time_column</span> <span class='kw'>=</span> <span class='fu'>c</span>(<span class='st'>"datetime"</span>, <span class='st'>"t"</span>, <span class='st'>"t_firstjan"</span>,
<span class='st'>"t_rel_to_max"</span>), <span class='kw'>xlab</span> <span class='kw'>=</span> <span class='st'>"default"</span>, <span class='kw'>ylab</span> <span class='kw'>=</span> <span class='st'>"default"</span>, <span class='kw'>add</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>,
<span class='kw'>threshold_factor</span> <span class='kw'>=</span> <span class='fl'>1000</span>, <span class='kw'>thin_low</span> <span class='kw'>=</span> <span class='fl'>1</span>, <span class='kw'>total</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>, <span class='kw'>LC_TIME</span> <span class='kw'>=</span> <span class='st'>"C"</span>,
<span class='no'>...</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>
<tr>
<th>x</th>
<td><p>The TOXSWA_cwa object to be plotted.</p></td>
</tr>
<tr>
<th>time_column</th>
<td><p>What should be used for the time axis. If "t_firstjan" is chosen,
the time is given in days relative to the first of January in the first year.</p></td>
</tr>
<tr>
<th>xlab, ylab</th>
<td><p>Labels for x and y axis.</p></td>
</tr>
<tr>
<th>add</th>
<td><p>Should we add to an existing plot?</p></td>
</tr>
<tr>
<th>threshold_factor</th>
<td><p>The factor by which the data have to be lower than the maximum
in order to get thinned for plotting (see next argument).</p></td>
</tr>
<tr>
<th>thin_low</th>
<td><p>If an integer greater than 1, the data close to zero (smaller than
1/threshold_factor of the maximum) in the series will be thinned by this factor
in order to decrease the amount of data that is included in the plots</p></td>
</tr>
<tr>
<th>total</th>
<td><p>Should the total concentration in water be plotted, including substance sorbed
to suspended matter?</p></td>
</tr>
<tr>
<th>LC_TIME</th>
<td><p>Specification of the locale used to format dates</p></td>
</tr>
<tr>
<th>...</th>
<td><p>Further arguments passed to <code>plot</code> if we are not adding to an existing plot</p></td>
</tr>
</table>
<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'><-</span> <span class='fu'><a href='read.TOXSWA_cwa.html'>read.TOXSWA_cwa</a></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>))
<span class='fu'>plot</span>(<span class='no'>H_sw_D4_pond</span>)</div><div class='img'><img src='plot.TOXSWA_cwa-1.png' alt='' width='700' height='433' /></div><div class='input'><span class='fu'>plot</span>(<span class='no'>H_sw_D4_pond</span>, <span class='kw'>time_column</span> <span class='kw'>=</span> <span class='st'>"t"</span>)</div><div class='img'><img src='plot.TOXSWA_cwa-2.png' alt='' width='700' height='433' /></div><div class='input'><span class='fu'>plot</span>(<span class='no'>H_sw_D4_pond</span>, <span class='kw'>time_column</span> <span class='kw'>=</span> <span class='st'>"t_firstjan"</span>)</div><div class='img'><img src='plot.TOXSWA_cwa-3.png' alt='' width='700' height='433' /></div><div class='input'><span class='fu'>plot</span>(<span class='no'>H_sw_D4_pond</span>, <span class='kw'>time_column</span> <span class='kw'>=</span> <span class='st'>"t_rel_to_max"</span>)</div><div class='img'><img src='plot.TOXSWA_cwa-4.png' alt='' width='700' height='433' /></div><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'>system.file</span>(<span class='st'>"testdata/SwashProjects.zip"</span>, <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"pfm"</span>))
<span class='fu'>plot</span>(<span class='no'>H_sw_R1_stream</span>, <span class='kw'>time_column</span> <span class='kw'>=</span> <span class='st'>"t_rel_to_max"</span>)</div><div class='img'><img src='plot.TOXSWA_cwa-5.png' alt='' width='700' height='433' /></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="#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://pkgdown.r-lib.org/">pkgdown</a>.</p>
</div>
</footer>
</div>
</body>
</html>
|
