summaryrefslogblamecommitdiff
path: root/docs/reference/plot.TOXSWA_cwa.html
blob: 51b589cd116295ac729b9babdeac89425373adc7 (plain) (tree) 
a76221d ^

f0bf040 ^



d66bd4a ^

a76221d ^

f0bf040 ^



d66bd4a ^

a76221d ^

f0bf040 ^


d81550d ^

d66bd4a ^



a76221d ^

d66bd4a ^

f0bf040 ^





d66bd4a ^

a76221d ^

f0bf040 ^

d66bd4a ^




f0bf040 ^


d66bd4a ^


a76221d ^


d66bd4a ^

a76221d ^


197606d ^

a76221d ^

d66bd4a ^


f0bf040 ^

aed160d ^














d66bd4a ^


f0bf040 ^



aed160d ^



f0bf040 ^

aed160d ^




f0bf040 ^

aed160d ^



f0bf040 ^

aed160d ^



f0bf040 ^

aed160d ^




f0bf040 ^

aed160d ^

b9ce447 ^

aed160d ^



f0bf040 ^

aed160d ^




f0bf040 ^

aed160d ^

a76221d ^

aed160d ^

f0bf040 ^

aed160d ^



d66bd4a ^


b935273 ^

d66bd4a ^




aed160d ^



















f0bf040 ^

d66bd4a ^

a76221d ^

803fe13 ^

d66bd4a ^

f0bf040 ^

a76221d ^


d66bd4a ^

f0bf040 ^

a76221d ^

803fe13 ^

d66bd4a ^

197606d ^

803fe13 ^

f0bf040 ^


197606d ^

aed160d ^

803fe13 ^

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
128
129
130

131

132

133

134

135

136

137
138

139

140

141

142

143

144

145

146
147

148

149

150

               


                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  
                                                                          
 


                                                                                                                                      
                                                             
 

                                                                                                                         
 


                                                                                                                                                                                
 
                                                           




                                                                                                                                                                                                     
                 
 
 



                                                            

                                                       

                                                                                                                                                                      

          
                                                

                                                                              
          
 

                                                                                             
                                                                                                                                   













                                                                                                                                                                                                                                                                                                                                                

                                                                                                 


                                                                                 


                                                    
                                                                                                           



                                                                                      
                                                                                                      


                                        
                                                                                   


                                                  
                                                                                                                          



                                                                     
                                                                                                  
                                                                         
                                                                               


                                                                              
                                                                                         



                                                                                     
                                                                                               
                                                                
 
 
                                                                               


                                                                                                      

                                                                                        
                         



                                                                                                      


















                                                                                                                                                                                                                                                                                                                                                                                          
                                                                                                   
                        
 
 
                                             
                                     

      
                                  
                                                                                                      
      
 
                   
 
 

 
 
                
 
<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Plot TOXSWA surface water concentrations — plot.TOXSWA_cwa • pfm</title><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Plot TOXSWA surface water concentrations — plot.TOXSWA_cwa"><meta name="description" content="Plot TOXSWA hourly concentrations of a chemical substance in a specific
segment of a TOXSWA surface water body."><meta property="og:description" content="Plot TOXSWA hourly concentrations of a chemical substance in a specific
segment of a TOXSWA surface water body."></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">pfm</a>

    <small class="nav-text text-muted me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="">0.6.4</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
<li class="nav-item"><a class="external-link nav-link" href="https://github.com/jranke/pfm/" aria-label="GitHub"><span class="fa fab fa-github fa-lg"></span></a></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">

      <h1>Plot TOXSWA surface water concentrations</h1>
      <small class="dont-index">Source: <a href="https://github.com/jranke/pfm/blob/HEAD/R/TOXSWA_cwa.R" class="external-link"><code>R/TOXSWA_cwa.R</code></a></small>
      <div class="d-none name"><code>plot.TOXSWA_cwa.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Plot TOXSWA hourly concentrations of a chemical substance in a specific
segment of a TOXSWA surface water body.</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="co"># S3 method for class 'TOXSWA_cwa'</span></span>
<span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span></span>
<span>  <span class="va">x</span>,</span>
<span>  time_column <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/c.html" class="external-link">c</a></span><span class="op">(</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="op">)</span>,</span>
<span>  xlab <span class="op">=</span> <span class="st">"default"</span>,</span>
<span>  ylab <span class="op">=</span> <span class="st">"default"</span>,</span>
<span>  add <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  threshold_factor <span class="op">=</span> <span class="fl">1000</span>,</span>
<span>  thin_low <span class="op">=</span> <span class="fl">1</span>,</span>
<span>  total <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  LC_TIME <span class="op">=</span> <span class="st">"C"</span>,</span>
<span>  <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-x">x<a class="anchor" aria-label="anchor" href="#arg-x"></a></dt>
<dd><p>The TOXSWA_cwa object to be plotted.</p></dd>


<dt id="arg-time-column">time_column<a class="anchor" aria-label="anchor" href="#arg-time-column"></a></dt>
<dd><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></dd>


<dt id="arg-xlab-ylab">xlab, ylab<a class="anchor" aria-label="anchor" href="#arg-xlab-ylab"></a></dt>
<dd><p>Labels for x and y axis.</p></dd>


<dt id="arg-add">add<a class="anchor" aria-label="anchor" href="#arg-add"></a></dt>
<dd><p>Should we add to an existing plot?</p></dd>


<dt id="arg-threshold-factor">threshold_factor<a class="anchor" aria-label="anchor" href="#arg-threshold-factor"></a></dt>
<dd><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></dd>


<dt id="arg-thin-low">thin_low<a class="anchor" aria-label="anchor" href="#arg-thin-low"></a></dt>
<dd><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></dd>


<dt id="arg-total">total<a class="anchor" aria-label="anchor" href="#arg-total"></a></dt>
<dd><p>Should the total concentration in water be plotted, including substance sorbed
to suspended matter?</p></dd>


<dt id="arg-lc-time">LC_TIME<a class="anchor" aria-label="anchor" href="#arg-lc-time"></a></dt>
<dd><p>Specification of the locale used to format dates</p></dd>


<dt id="arg--">...<a class="anchor" aria-label="anchor" href="#arg--"></a></dt>
<dd><p>Further arguments passed to <code>plot</code> if we are not adding to an existing plot</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="author">Author<a class="anchor" aria-label="anchor" href="#author"></a></h2>
    <p>Johannes Ranke</p>
    </div>

    <div class="section level2">
    <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">H_sw_D4_pond</span>  <span class="op">&lt;-</span> <span class="fu"><a href="read.TOXSWA_cwa.html">read.TOXSWA_cwa</a></span><span class="op">(</span><span class="st">"00001p_pa.cwa"</span>,</span></span>
<span class="r-in"><span>  basedir <span class="op">=</span> <span class="st">"SwashProjects/project_H_sw/TOXSWA"</span>,</span></span>
<span class="r-in"><span>  zipfile <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/system.file.html" class="external-link">system.file</a></span><span class="op">(</span><span class="st">"testdata/SwashProjects.zip"</span>, package <span class="op">=</span> <span class="st">"pfm"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">H_sw_D4_pond</span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="plot.TOXSWA_cwa-1.png" alt="" width="700" height="433"></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">H_sw_D4_pond</span>, time_column <span class="op">=</span> <span class="st">"t"</span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="plot.TOXSWA_cwa-2.png" alt="" width="700" height="433"></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">H_sw_D4_pond</span>, time_column <span class="op">=</span> <span class="st">"t_firstjan"</span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="plot.TOXSWA_cwa-3.png" alt="" width="700" height="433"></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">H_sw_D4_pond</span>, time_column <span class="op">=</span> <span class="st">"t_rel_to_max"</span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="plot.TOXSWA_cwa-4.png" alt="" width="700" height="433"></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span><span class="va">H_sw_R1_stream</span>  <span class="op">&lt;-</span> <span class="fu"><a href="read.TOXSWA_cwa.html">read.TOXSWA_cwa</a></span><span class="op">(</span><span class="st">"00003s_pa.cwa"</span>,</span></span>
<span class="r-in"><span>  basedir <span class="op">=</span> <span class="st">"SwashProjects/project_H_sw/TOXSWA"</span>,</span></span>
<span class="r-in"><span>  zipfile <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/system.file.html" class="external-link">system.file</a></span><span class="op">(</span><span class="st">"testdata/SwashProjects.zip"</span>, package <span class="op">=</span> <span class="st">"pfm"</span><span class="op">)</span><span class="op">)</span></span></span>
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">H_sw_R1_stream</span>, time_column <span class="op">=</span> <span class="st">"t_rel_to_max"</span><span class="op">)</span></span></span>
<span class="r-plt img"><img src="plot.TOXSWA_cwa-5.png" alt="" width="700" height="433"></span>
</code></pre></div>
    </div>
  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>Developed by Johannes Ranke.</p>
</div>

<div class="pkgdown-footer-right">
  <p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.0.</p>
</div>

    </footer></div>





  </body></html>

Contact - Imprint