aboutsummaryrefslogblamecommitdiff
path: root/docs/reference/TOXSWA_cwa.html
blob: 9f9e3c3732b4a05cb2b7e08af913b09bf28baf7f (plain) (tree)
1
2
3
4
5
6
7
8
9

                                                  
                




                                                                      
                                                                                                                    
 
 
               
                                                                                                                                                                                 

                  
                                                                                                                                                                                                             
 




                                                                                                                                                                                                  

                           

                                                                                                                                                                                                        
 
                     
                                                                                                                                                                                          
 
                    

                                                                                                                                                                                             
 

                                             
                                     


 
 
                                                                                                                                    
                                                                                                                                      
                                                                            


 
 
                

                                                                                                                                                                                                    




                                                                               

 
 

         
                                             




                                                                            

                                                                                                                               



                                      

                                                           
                                                                                                                                     
             
          
 


                                                      
                          
                                                  



      


                                                 
                                              
        
           
      




                                
 

               
                 

                                 
                                                                                           
    
                                                             

          
                                 
                                                                                                    
                                                                                                                            
          
 

 


                                                                                      
                                                                                         
 
    
 
     











                                                                                                                                                  
                                       
                                                                          









                                                                                                                     
                                                                               
                                                       
 
                  

                                                                                         
    
                       
 










                                                                                             






                                                                                               





                                                                                   
                                                                                                                                                                                                                                               




                                                                           
                                                                                                                                                                                                                                              




                                                                                                                 
                                                                                                                                                                



                                                                              
                                                                                                                                                                                                    

                  
                                   


                                                                       
 
 



                                                                                                                                                                                                                                      
                                                                                                                                                                                                                                          
                                                                                                                                      


                                                                                                                                                                                                                   

























                                                                           



                                                                 


        
 





                                     
                                                                                
      
 


               

  
 

         
 
 
<!-- Generated by pkgdown: do not edit by hand -->
<!DOCTYPE html>
<html lang="en">
  <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>R6 class for holding TOXSWA water concentration data and associated statistics — TOXSWA_cwa • pfm</title>


<!-- jquery -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
<!-- Bootstrap -->

<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />

<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>

<!-- bootstrap-toc -->
<link rel="stylesheet" href="../bootstrap-toc.css">
<script src="../bootstrap-toc.js"></script>

<!-- Font Awesome icons -->
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />

<!-- clipboard.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>

<!-- headroom.js -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>

<!-- pkgdown -->
<link href="../pkgdown.css" rel="stylesheet">
<script src="../pkgdown.js"></script>




<meta property="og:title" content="R6 class for holding TOXSWA water concentration data and associated statistics — TOXSWA_cwa" />
<meta property="og:description" content="An R6 class for holding TOXSWA water concentration (cwa) data and some associated statistics.
Usually, an instance of this class will be generated by read.TOXSWA_cwa." />




<!-- mathjax -->
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></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 data-spy="scroll" data-target="#toc">
    <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" aria-expanded="false">
        <span class="sr-only">Toggle navigation</span>
        <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="version label label-default" data-toggle="tooltip" data-placement="bottom" title="Released version">0.5.7</span>
      </span>
    </div>

    <div id="navbar" class="navbar-collapse collapse">
      <ul class="nav navbar-nav">
        <li>
  <a href="../index.html">
    <span class="fas fa fas fa-home fa-lg"></span>
     
  </a>
</li>
<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>R6 class for holding TOXSWA water concentration data and associated statistics</h1>
    
    <div class="hidden name"><code>TOXSWA_cwa.Rd</code></div>
    </div>

    <div class="ref-description">
    <p>An R6 class for holding TOXSWA water concentration (cwa) data and some associated statistics.
Usually, an instance of this class will be generated by <code><a href='read.TOXSWA_cwa.html'>read.TOXSWA_cwa</a></code>.</p>
    </div>



    <h2 class="hasAnchor" id="format"><a class="anchor" href="#format"></a>Format</h2>

    <p>An <code>R6Class</code> generator object.</p>
    <h2 class="hasAnchor" id="methods"><a class="anchor" href="#methods"></a>Methods</h2>

    

<dl'>
  <dt><code>get_events(threshold, total = FALSE)</code></dt><dd><p>Populate a datataframe with event information for the specified threshold value
        in µg/L. If <code>total = TRUE</code>, the total concentration including the amount
        adsorbed to suspended matter will be used. The resulting dataframe is stored in the
        <code>events</code> field of the object.</p></dd>
  <dt><code>moving_windows(windows, total = FALSE)</code></dt><dd><p>Add to the <code>windows</code> field described above.
        Again, if <code>total = TRUE</code>, the total concentration including the amount
        adsorbed to suspended matter will be used.</p></dd>

</dl>

    <h2 class="hasAnchor" id="public-fields"><a class="anchor" href="#public-fields"></a>Public fields</h2>

    <p><div class="r6-fields"></p><dl'>
<dt><code>filename</code></dt><dd><p>Length one character vector.</p></dd>

<dt><code>basedir</code></dt><dd><p>Length one character vector.</p></dd>

<dt><code>segment</code></dt><dd><p>Length one integer, specifying for which segment the cwa data were read.</p></dd>

<dt><code>cwas</code></dt><dd><p>Dataframe holding the concentrations.</p></dd>

<dt><code>events</code></dt><dd><p>List of dataframes holding the event statistics for each threshold.</p></dd>

<dt><code>windows</code></dt><dd><p>Matrix of maximum time weighted average concentrations (TWAC_max)
and areas under the curve in µg/day * h (AUC_max_h) or µg/day * d (AUC_max_d)
for the requested moving window sizes in days.</p></dd>

</dl><p></div></p>
    <h2 class="hasAnchor" id="methods"><a class="anchor" href="#methods"></a>Methods</h2>

    
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-new'><code>TOXSWA_cwa$new()</code></a></p></li>
<li><p><a href='#method-moving_windows'><code>TOXSWA_cwa$moving_windows()</code></a></p></li>
<li><p><a href='#method-get_events'><code>TOXSWA_cwa$get_events()</code></a></p></li>
<li><p><a href='#method-print'><code>TOXSWA_cwa$print()</code></a></p></li>
<li><p><a href='#method-clone'><code>TOXSWA_cwa$clone()</code></a></p></li>
</ul>
<p><hr>
<a id="method-new"></a></p><h3>Method <code>new()</code></h3>

<h3>Usage</h3>
<p><div class="r"></p><pre><span class='no'>TOXSWA_cwa</span>$<span class='fu'>new</span>(
  <span class='no'>filename</span>,
  <span class='no'>basedir</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>
)</pre><p></div></p>

<p><hr>
<a id="method-moving_windows"></a></p><h3>Method <code>moving_windows()</code></h3>

<h3>Usage</h3>
<p><div class="r"></p><pre><span class='no'>TOXSWA_cwa</span>$<span class='fu'>moving_windows</span>(<span class='no'>windows</span>, <span class='kw'>total</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre><p></div></p>

<p><hr>
<a id="method-get_events"></a></p><h3>Method <code>get_events()</code></h3>

<h3>Usage</h3>
<p><div class="r"></p><pre><span class='no'>TOXSWA_cwa</span>$<span class='fu'>get_events</span>(<span class='no'>thresholds</span>, <span class='kw'>total</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre><p></div></p>

<p><hr>
<a id="method-print"></a></p><h3>Method <code><a href='https://rdrr.io/r/base/print.html'>print()</a></code></h3>

<h3>Usage</h3>
<p><div class="r"></p><pre><span class='no'>TOXSWA_cwa</span>$<span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span>()</pre><p></div></p>

<p><hr>
<a id="method-clone"></a></p><h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><h3>Usage</h3>
<p><div class="r"></p><pre><span class='no'>TOXSWA_cwa</span>$<span class='fu'>clone</span>(<span class='kw'>deep</span> <span class='kw'>=</span> <span class='fl'>FALSE</span>)</pre><p></div></p>

<h3>Arguments</h3>
<p><div class="arguments"></p><dl'>
<dt><code>deep</code></dt><dd><p>Whether to make a deep clone.</p></dd>

</dl><p></div></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_R1_stream</span>  <span class='kw'>&lt;-</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'><a href='https://rdrr.io/r/base/system.file.html'>system.file</a></span>(<span class='st'>"testdata/SwashProjects.zip"</span>,
                                             <span class='kw'>package</span> <span class='kw'>=</span> <span class='st'>"pfm"</span>))
<span class='no'>H_sw_R1_stream</span>$<span class='fu'>get_events</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>2</span>, <span class='fl'>10</span>))
<span class='no'>H_sw_R1_stream</span>$<span class='fu'>moving_windows</span>(<span class='fu'><a href='https://rdrr.io/r/base/c.html'>c</a></span>(<span class='fl'>7</span>, <span class='fl'>21</span>))
<span class='fu'><a href='https://rdrr.io/r/base/print.html'>print</a></span>(<span class='no'>H_sw_R1_stream</span>)</div><div class='output co'>#&gt; &lt;TOXSWA_cwa&gt; data from file 00003s_pa.cwa segment 20 
#&gt;                datetime     t t_firstjan t_rel_to_max cwa_mug_per_L
#&gt; 20  1978-10-01 00:00:00 0.000   273.0000      -55.333             0
#&gt; 40  1978-10-01 01:00:00 0.042   273.0417      -55.291             0
#&gt; 60  1978-10-01 02:00:00 0.083   273.0833      -55.250             0
#&gt; 80  1978-10-01 03:00:00 0.125   273.1250      -55.208             0
#&gt; 100 1978-10-01 04:00:00 0.167   273.1667      -55.166             0
#&gt; 120 1978-10-01 05:00:00 0.208   273.2083      -55.125             0
#&gt;     cwa_tot_mug_per_L
#&gt; 20                  0
#&gt; 40                  0
#&gt; 60                  0
#&gt; 80                  0
#&gt; 100                 0
#&gt; 120                 0
#&gt; Moving window analysis
#&gt;    window  max_TWAC max_AUC_h max_AUC_d
#&gt; 1  7 days 2.3926551  401.9660  16.74859
#&gt; 2 21 days 0.8369248  421.8101  17.57542
#&gt; Event statistics for threshold 2 
#&gt;   t_start   cwa_max duration pre_interval     AUC_h     AUC_d
#&gt; 1  44.375  4.167238    0.208       44.375  17.77202  0.740501
#&gt; 2  55.042 40.584010    0.583       10.459 398.21189 16.592162
#&gt; Event statistics for threshold 10 
#&gt;   t_start  cwa_max duration pre_interval   AUC_h    AUC_d
#&gt; 1  55.083 40.58401    0.459       55.083 379.433 15.80971</div></pre>
  </div>
  <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
    <nav id="toc" data-toggle="toc" class="sticky-top">
      <h2 data-toc-skip>Contents</h2>
    </nav>
  </div>
</div>


      <footer>
      <div class="copyright">
  <p>Developed by Johannes Ranke.</p>
</div>

<div class="pkgdown">
  <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.5.1.</p>
</div>

      </footer>
   </div>

  


  </body>
</html>


Contact - Imprint