From e0c130005ee7adbac9b832ea8157712419d51b7e Mon Sep 17 00:00:00 2001
From: Ranke Johannes
Date: Mon, 22 Jun 2026 18:01:11 +0200
Subject: Update static docs
---
docs/reference/TOXSWA_cwa.html | 90 +++++++++++++++++++-----------------------
1 file changed, 41 insertions(+), 49 deletions(-)
(limited to 'docs/reference/TOXSWA_cwa.html')
diff --git a/docs/reference/TOXSWA_cwa.html b/docs/reference/TOXSWA_cwa.html
index 234c89a..2087177 100644
--- a/docs/reference/TOXSWA_cwa.html
+++ b/docs/reference/TOXSWA_cwa.html
@@ -15,7 +15,7 @@ by read.TOXSWA_cwa.">
pfm
- 0.6.4
+ 0.6.5
@@ -46,13 +46,13 @@ by read.TOXSWA_cwa.">
and some associated statistics. like maximum moving window average
concentrations, and dataframes holding the events exceeding specified
thresholds. Usually, an instance of this class will be generated
-by read.TOXSWA_cwa .
+by
Public fields
@@ -60,31 +60,31 @@ by
read.TOXSWA_cwa .
Length one character vector holding the filename.
-
basedir
+
basedir
Length one character vector holding the directory where the file came from.
-
zipfile
+
zipfile
If not null, giving the path to the zip file from which the file was read.
-
segment
+
segment
Length one integer, specifying for which segment the cwa data were read.
-
substance
+
substance
The TOXSWA name of the substance.
-
cwas
+
cwas
Dataframe holding the concentrations.
-
events
+
events
List of dataframes holding the event statistics for each threshold.
-
windows
+
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.
@@ -97,14 +97,13 @@ for the requested moving window sizes in days.
+
TOXSWA_cwa$new()
Create a TOXSWA_cwa object from a file
Usage
TOXSWA_cwa $ new (
@@ -115,51 +114,43 @@ for the requested moving window sizes in days.
substance = "parent" ,
total = FALSE
)
-
-
-
+
Arguments
filename
The filename
-
-basedir
+ basedir
The directory to look in
-
-zipfile
+ zipfile
Optional path to a zipfile holding the file
-
-segment
+ segment
Either "last" or the number of the segment for which to read the data
-
-substance
+ substance
The TOXSWA substance name (for TOXSWA 4 or higher)
-
-total
+ total
Should total concentrations be read in? If FALSE, free concentrations are read
-
-
Method moving_windows()
+
+
+
+
TOXSWA_cwa$moving_windows()
Add to the windows field described above.
Usage
TOXSWA_cwa $ moving_windows ( windows , total = FALSE )
-
-
-
+
Arguments
windows
Window sizes in days
-
-total
+ total
If TRUE, the total concentration including the amount adsorbed to
suspended matter will be used.
@@ -167,22 +158,21 @@ suspended matter will be used.
-
+
+
+
TOXSWA_cwa$get_events()
Populate a datataframe with event information for the specified
threshold value. The resulting dataframe is stored in the events
field of the object.
Usage
TOXSWA_cwa $ get_events ( thresholds , total = FALSE )
-
-
-
+
Arguments
thresholds
Threshold values in µg/L.
-
-total
+ total
If TRUE, the total concentration including the amount adsorbed to
suspended matter will be used.
@@ -190,22 +180,23 @@ suspended matter will be used.
-
+
+
+
TOXSWA_cwa$print()
Print a TOXSWA_cwa object
+
-