From d81550d0cccae824cc748de48e7fd50ea8d8033a Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 16 Apr 2020 18:02:18 +0200 Subject: Make na.rm = FALSE the default for geomean() This makes more sense and is in line with mean() from base R. Adapt tests and update docs. --- docs/reference/TOXSWA_cwa.html | 97 +++++++++++++++++++++++++++++++----------- 1 file changed, 72 insertions(+), 25 deletions(-) (limited to 'docs/reference/TOXSWA_cwa.html') diff --git a/docs/reference/TOXSWA_cwa.html b/docs/reference/TOXSWA_cwa.html index 8939850..cedb023 100644 --- a/docs/reference/TOXSWA_cwa.html +++ b/docs/reference/TOXSWA_cwa.html @@ -8,11 +8,13 @@ R6 class for holding TOXSWA water concentration data and associated statistics — TOXSWA_cwa • pfm + + @@ -32,14 +34,15 @@ - + + @@ -83,7 +86,6 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." /> Reference - @@ -105,23 +107,33 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." />
-

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.

-
- 
TOXSWA_cwa
- + +

Format

An R6Class generator object.

- -

Fields

+

Methods

+
get_events(threshold, total = FALSE)

Populate a datataframe with event information for the specified threshold value + in µg/L. If total = TRUE, the total concentration including the amount + adsorbed to suspended matter will be used. The resulting dataframe is stored in the + events field of the object.

+
moving_windows(windows, total = FALSE)

Add to the windows field described above. + Again, if total = TRUE, the total concentration including the amount + adsorbed to suspended matter will be used.

+ +
+ +

Public fields

+ +

filename

Length one character vector.

basedir

Length one character vector.

@@ -136,24 +148,62 @@ Usually, an instance of this class will be generated by -
get_events(threshold, total = FALSE)

Populate a datataframe with event information for the specified threshold value - in µg/L. If total = TRUE, the total concentration including the amount - adsorbed to suspended matter will be used. The resulting dataframe is stored in the - events field of the object.

-
moving_windows(windows, total = FALSE)

Add to the windows field described above. - Again, if total = TRUE, the total concentration including the amount - adsorbed to suspended matter will be used.

+ +

+

Method new()

+ +

Usage

+

TOXSWA_cwa$new(
+  filename,
+  basedir,
+  zipfile = NULL,
+  segment = "last",
+  substance = "parent",
+  total = FALSE
+)

+ +

+

Method moving_windows()

+ +

Usage

+

TOXSWA_cwa$moving_windows(windows, total = FALSE)

+ +

+

Method get_events()

+ +

Usage

+

TOXSWA_cwa$get_events(thresholds, total = FALSE)

+ +

+

Method print()

+ +

Usage

+

TOXSWA_cwa$print()

+ +

+

Method clone()

+

The objects of this class are cloneable with this method.

Usage

+

TOXSWA_cwa$clone(deep = FALSE)

+ +

Arguments

+

+
deep

Whether to make a deep clone.

+ +

-
-

Examples

H_sw_R1_stream  <- read.TOXSWA_cwa("00003s_pa.cwa",
@@ -192,13 +242,10 @@ for the requested moving window sizes in days.