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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/TOXSWA_cwa.R
\docType{class}
\name{TOXSWA_cwa}
\alias{TOXSWA_cwa}
\title{R6 class for holding TOXSWA water concentration data and associated statistics}
\format{An \code{\link{R6Class}} generator object.}
\description{
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{\link{read.TOXSWA_cwa}}.
}
\section{Methods}{
\describe{
\item{\code{get_events(threshold, total = FALSE)}}{
Populate a datataframe with event information for the specified threshold value
in µg/L. If \code{total = TRUE}, the total concentration including the amount
adsorbed to suspended matter will be used. The resulting dataframe is stored in the
\code{events} field of the object.
}
\item{\code{moving_windows(windows, total = FALSE)}}{
Add to the \code{windows} field described above.
Again, if \code{total = TRUE}, the total concentration including the amount
adsorbed to suspended matter will be used.
}
}
}
\examples{
H_sw_R1_stream <- read.TOXSWA_cwa("00003s_pa.cwa",
basedir = "SwashProjects/project_H_sw/TOXSWA",
zipfile = system.file("testdata/SwashProjects.zip",
package = "pfm"))
H_sw_R1_stream$get_events(c(2, 10))
H_sw_R1_stream$moving_windows(c(7, 21))
print(H_sw_R1_stream)
}
\keyword{data}
\section{Public fields}{
\if{html}{\out{<div class="r6-fields">}}
\describe{
\item{\code{filename}}{Length one character vector.}
\item{\code{basedir}}{Length one character vector.}
\item{\code{segment}}{Length one integer, specifying for which segment the cwa data were read.}
\item{\code{cwas}}{Dataframe holding the concentrations.}
\item{\code{events}}{List of dataframes holding the event statistics for each threshold.}
\item{\code{windows}}{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.}
}
\if{html}{\out{</div>}}
}
\section{Methods}{
\subsection{Public methods}{
\itemize{
\item \href{#method-new}{\code{TOXSWA_cwa$new()}}
\item \href{#method-moving_windows}{\code{TOXSWA_cwa$moving_windows()}}
\item \href{#method-get_events}{\code{TOXSWA_cwa$get_events()}}
\item \href{#method-print}{\code{TOXSWA_cwa$print()}}
\item \href{#method-clone}{\code{TOXSWA_cwa$clone()}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-new"></a>}}
\subsection{Method \code{new()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{TOXSWA_cwa$new(
filename,
basedir,
zipfile = NULL,
segment = "last",
substance = "parent",
total = FALSE
)}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-moving_windows"></a>}}
\subsection{Method \code{moving_windows()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{TOXSWA_cwa$moving_windows(windows, total = FALSE)}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-get_events"></a>}}
\subsection{Method \code{get_events()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{TOXSWA_cwa$get_events(thresholds, total = FALSE)}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-print"></a>}}
\subsection{Method \code{print()}}{
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{TOXSWA_cwa$print()}\if{html}{\out{</div>}}
}
}
\if{html}{\out{<hr>}}
\if{html}{\out{<a id="method-clone"></a>}}
\subsection{Method \code{clone()}}{
The objects of this class are cloneable with this method.
\subsection{Usage}{
\if{html}{\out{<div class="r">}}\preformatted{TOXSWA_cwa$clone(deep = FALSE)}\if{html}{\out{</div>}}
}
\subsection{Arguments}{
\if{html}{\out{<div class="arguments">}}
\describe{
\item{\code{deep}}{Whether to make a deep clone.}
}
\if{html}{\out{</div>}}
}
}
}
|
