aboutsummaryrefslogblamecommitdiff
path: root/pkg/inst/web/read.TOXSWA_cwa.html
blob: 5542fcadbd694464d93d917c1e155442876b70cc (plain) (tree) 
3a579d8































































































































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127































































































































                                                                                                                                                                                         
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
<title>read.TOXSWA_cwa. pfm 0.3-1</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="#">pfm 0.3-1</a>
      <div class="nav">
        <ul class="nav">
          <li><a href="index.html"><i class="icon-home icon-white"></i> Index</a></li>
        </ul>
      </div>
    </div>
  </div>
</div>

    <div class="container">
      <header>
        
      </header>
      
      <h1>Read TOXSWA surface water concentrations</h1>

<div class="row">
  <div class="span8">
    <h2>Usage</h2>
    <pre><div>read.TOXSWA_cwa(filename, basedir&nbsp;=&nbsp;".", zipfile&nbsp;=&nbsp;NULL, segment&nbsp;=&nbsp;"last", windows&nbsp;=&nbsp;NULL, thresholds&nbsp;=&nbsp;NULL)</div></pre>
    
    <h2>Arguments</h2>
    <dl>
      <dt>filename</dt>
      <dd>The filename of the cwa file.</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 "last", or 
the segment number.</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>
    
    <div class="Value">
      <h2>Value</h2>

      <p><dl>
An instance of an R6 object of class
<code><a href='TOXSWA_cwa.html'>TOXSWA_cwa</a></code>.
</dl></p>
  
    </div>

    <div class="Description">
      <h2>Description</h2>

      <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.</p>
  
    </div>
    
    <h2 id="examples">Examples</h2>
    <pre class="examples"><div class='input'>H_sw_D4_pond  &lt;- read.TOXSWA_cwa(&quot;00001p_pa.cwa&quot;,
                                 basedir = &quot;SwashProjects/project_H_sw/TOXSWA&quot;,
                                 zipfile = system.file(&quot;testdata/SwashProjects.zip&quot;,
                                                       package = &quot;pfm&quot;))
</div></pre>
  </div>
  <div class="span4">
    <!-- <ul>
      <li>read.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="http://twitter.github.com/bootstrap">bootstrap</a>.</p>
      </footer>
    </div>
  </body>
</html>

Contact - Imprint