From aed160d7f0eaf5865e2bd9bf6c4b1c9d7b13d911 Mon Sep 17 00:00:00 2001 From: Ranke Johannes Date: Wed, 31 Jan 2024 13:16:17 +0100 Subject: Reorganise data generation - Use inst/data_generation for R code generating data as in some of my other packages - data/*.RData files were checked using https://github.com/jranke/dotfiles/blob/main/bin/rda_diff contents were not changed - Remove ChangeLog, the history is in the git logs - Update docs and some links contained therein - use \doi{} markup - Move logs to log directory --- docs/reference/read.TOXSWA_cwa.html | 243 +++++++++++++----------------------- 1 file changed, 88 insertions(+), 155 deletions(-) (limited to 'docs/reference/read.TOXSWA_cwa.html') diff --git a/docs/reference/read.TOXSWA_cwa.html b/docs/reference/read.TOXSWA_cwa.html index 9c5c2a0..2685c21 100644 --- a/docs/reference/read.TOXSWA_cwa.html +++ b/docs/reference/read.TOXSWA_cwa.html @@ -1,69 +1,17 @@ - - - - - - - -Read TOXSWA surface water concentrations — read.TOXSWA_cwa • pfm - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Read TOXSWA surface water concentrations — read.TOXSWA_cwa • pfm - - - - - - - - - - - - - - + + -
-
- -
- -
+

Read TOXSWA surface water concentrations

@@ -119,103 +53,102 @@ of the hourly averages (ConLiqWatLay). In TOXSWA 5.5.3 this variable was renamed to ConLiqWatLay in the out file.

- 
read.TOXSWA_cwa(
-  filename,
-  basedir = ".",
-  zipfile = NULL,
-  segment = "last",
-  substance = "parent",
-  total = FALSE,
-  windows = NULL,
-  thresholds = NULL
-)
- -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
filename

The filename of the cwa file (TOXSWA 2.x.y or similar) or the -out file when using FOCUS TOXSWA 4 (i.e. TOXSWA 4.4.2) or higher.

basedir

The path to the directory where the cwa file resides.

zipfile

Optional path to a zip file containing the cwa file.

segment

The segment for which the data should be read. Either "last", or -the segment number.

substance

For .out files, the default value "parent" leads +

+ 
read.TOXSWA_cwa(
+  filename,
+  basedir = ".",
+  zipfile = NULL,
+  segment = "last",
+  substance = "parent",
+  total = FALSE,
+  windows = NULL,
+  thresholds = NULL
+)
+
+ +
+

Arguments

+
filename
+

The filename of the cwa file (TOXSWA 2.x.y or similar) or the +out file when using FOCUS TOXSWA 4 (i.e. TOXSWA 4.4.2) or higher.

+ + +
basedir
+

The path to the directory where the cwa file resides.

+ + +
zipfile
+

Optional path to a zip file containing the cwa file.

+ + +
segment
+

The segment for which the data should be read. Either "last", or +the segment number.

+ + +
substance
+

For .out files, the default value "parent" leads to reading concentrations of the parent compound. Alternatively, the substance -of interested can be selected by its code name.

total

Set this to TRUE in order to read total concentrations as well. This is +of interested can be selected by its code name.

+ + +
total
+

Set this to TRUE in order to read total concentrations as well. This is only necessary for .out files as generated by TOXSWA 4.4.2 or similar, not for .cwa -files. For .cwa files, the total concentration is always read as well.

windows

Numeric vector of width of moving windows in days, for calculating -maximum time weighted average concentrations and areas under the curve.

thresholds

Numeric vector of threshold concentrations in µg/L for -generating event statistics.

- -

Value

- -

An instance of an R6 object of class -TOXSWA_cwa.

- -

Examples

- 
H_sw_D4_pond  <- read.TOXSWA_cwa("00001p_pa.cwa",
-                                 basedir = "SwashProjects/project_H_sw/TOXSWA",
-                                 zipfile = system.file("testdata/SwashProjects.zip",
-                                                       package = "pfm"))
-
- +
+

Value

+ +

An instance of an R6 object of class +TOXSWA_cwa.

+
+

Author

Johannes Ranke

+
+ +
+

Examples

+ 
H_sw_D4_pond  <- read.TOXSWA_cwa("00001p_pa.cwa",
+                                 basedir = "SwashProjects/project_H_sw/TOXSWA",
+                                 zipfile = system.file("testdata/SwashProjects.zip",
+                                                       package = "pfm"))
+
+
+
-
- - + + -- cgit v1.2.1