aboutsummaryrefslogtreecommitdiff
path: root/docs/plot.TOXSWA_cwa.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/plot.TOXSWA_cwa.html')
-rw-r--r--docs/plot.TOXSWA_cwa.html124
1 files changed, 124 insertions, 0 deletions
diff --git a/docs/plot.TOXSWA_cwa.html b/docs/plot.TOXSWA_cwa.html
new file mode 100644
index 0000000..87dae02
--- /dev/null
+++ b/docs/plot.TOXSWA_cwa.html
@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+<title>plot.TOXSWA_cwa. pfm 0.3-8</title>
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<meta name="author" content="
+Johannes Ranke
+">
+
+<link href="css/bootstrap.css" rel="stylesheet">
+<link href="css/bootstrap-responsive.css" rel="stylesheet">
+<link href="css/highlight.css" rel="stylesheet">
+<link href="css/staticdocs.css" rel="stylesheet">
+
+<!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+<![endif]-->
+
+<script type="text/x-mathjax-config">
+ MathJax.Hub.Config({
+ tex2jax: {
+ inlineMath: [ ['$','$'], ["\\(","\\)"] ],
+ processEscapes: true
+ }
+ });
+</script>
+<script type="text/javascript"
+ src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+</script>
+ </head>
+
+ <body>
+ <div class="navbar">
+ <div class="navbar-inner">
+ <div class="container">
+ <a class="brand" href="index.html">pfm 0.3-8</a>
+ <div class="nav">
+ <ul class="nav">
+ <li><a href="index.html">Home</a></li>
+ <li><a href="reference.html">Reference</a></li>
+ </ul>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ <div class="container">
+ <header>
+
+ </header>
+
+ <h1>Plot TOXSWA surface water concentrations</h1>
+
+<div class="row">
+ <div class="span8">
+ <h2>Usage</h2>
+ <pre><span class="comment"># S3 method for TOXSWA_cwa</span>
+<span class="functioncall"><a href='http://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span><span class="keyword">(</span><span class="symbol">x</span><span class="keyword">,</span> <span class="argument">time_column</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="functioncall"><a href='http://www.rdocumentation.org/packages/base/topics/c'>c</a></span><span class="keyword">(</span><span class="string">"datetime"</span><span class="keyword">,</span> <span class="string">"t"</span><span class="keyword">,</span> <span class="string">"t_firstjan"</span><span class="keyword">,</span>
+ <span class="string">"t_rel_to_max"</span><span class="keyword">)</span><span class="keyword">,</span> <span class="argument">xlab</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">"default"</span><span class="keyword">,</span> <span class="argument">ylab</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">"default"</span><span class="keyword">,</span> <span class="argument">add</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">FALSE</span><span class="keyword">,</span>
+ <span class="argument">total</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="number">FALSE</span><span class="keyword">,</span> <span class="argument">LC_TIME</span>&nbsp;<span class="argument">=</span>&nbsp;<span class="string">"C"</span><span class="keyword">,</span> <span class="symbol">...</span><span class="keyword">)</span></pre>
+
+ <h2>Arguments</h2>
+ <dl>
+ <dt>x</dt>
+ <dd>The TOXSWA_cwa object to be plotted.</dd>
+ <dt>time_column</dt>
+ <dd>What should be used for the time axis. If &quot;t_firstjan&quot; is chosen,
+the time is given in days relative to the first of January in the first year.</dd>
+ <dt>xlab, ylab</dt>
+ <dd>Labels for x and y axis.</dd>
+ <dt>add</dt>
+ <dd>Should we add to an existing plot?</dd>
+ <dt>total</dt>
+ <dd>Should the total concentration in water be plotted, including substance sorbed
+to suspended matter?</dd>
+ <dt>LC_TIME</dt>
+ <dd>Specification of the locale used to format dates</dd>
+ <dt>...</dt>
+ <dd>Further arguments passed to <code>plot</code> if we are not adding to an existing plot</dd>
+ </dl>
+
+ <div class="Description">
+ <h2>Description</h2>
+
+ <p>Plot TOXSWA hourly concentrations of a chemical substance in a specific
+segment of a TOXSWA surface water body.</p>
+
+ </div>
+
+ <h2 id="examples">Examples</h2>
+ <pre class="examples"><div class='input'><span class="symbol">H_sw_D4_pond</span> <span class="assignement">&lt;-</span> <span class="functioncall"><a href='read.TOXSWA_cwa.html'>read.TOXSWA_cwa</a></span><span class="keyword">(</span><span class="string">"00001p_pa.cwa"</span><span class="keyword">,</span>
+ <span class="argument">basedir</span> <span class="argument">=</span> <span class="string">"SwashProjects/project_H_sw/TOXSWA"</span><span class="keyword">,</span>
+ <span class="argument">zipfile</span> <span class="argument">=</span> <span class="functioncall"><a href='http://www.rdocumentation.org/packages/devtools/topics/system.file'>system.file</a></span><span class="keyword">(</span><span class="string">"testdata/SwashProjects.zip"</span><span class="keyword">,</span>
+ <span class="argument">package</span> <span class="argument">=</span> <span class="string">"pfm"</span><span class="keyword">)</span><span class="keyword">)</span>
+<span class="functioncall"><a href='http://www.rdocumentation.org/packages/graphics/topics/plot'>plot</a></span><span class="keyword">(</span><span class="symbol">H_sw_D4_pond</span><span class="keyword">)</span></div>
+<p><img src='plot.TOXSWA_cwa-2.png' alt='' width='540' height='400' /></p></pre>
+ </div>
+ <div class="span4 sidebar">
+ <!-- <ul>
+ <li>plot.TOXSWA_cwa</li>
+ </ul>
+ <ul>
+
+ </ul> -->
+
+
+
+ <h2>Author</h2>
+
+Johannes Ranke
+
+
+ </div>
+</div>
+
+ <footer>
+ <p class="pull-right"><a href="#">Back to top</a></p>
+<p>Built by <a href="https://github.com/hadley/staticdocs">staticdocs</a>. Styled with <a href="https://getbootstrap.com/2.0.4/">bootstrap</a>.</p>
+ </footer>
+ </div>
+ </body>
+</html> \ No newline at end of file

Contact - Imprint