From 90fa42c86596c85168931148bf8d5fa014fa7794 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Thu, 23 Jul 2020 10:51:39 +0200 Subject: Update docs, use R6 support of roxygen --- docs/reference/TOXSWA_cwa.html | 82 +++++++++++++++++++++++++++--------------- 1 file changed, 53 insertions(+), 29 deletions(-) (limited to 'docs/reference/TOXSWA_cwa.html') diff --git a/docs/reference/TOXSWA_cwa.html b/docs/reference/TOXSWA_cwa.html index 9f9e3c3..16dc5db 100644 --- a/docs/reference/TOXSWA_cwa.html +++ b/docs/reference/TOXSWA_cwa.html @@ -40,8 +40,11 @@ - + @@ -110,8 +113,11 @@ 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.

+

An R6 class for holding TOXSWA water concentration (cwa) data +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.

@@ -119,30 +125,19 @@ 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.

- - -

Public fields

-
filename

Length one character vector.

+
filename

Length one character vector holding the filename.

-
basedir

Length one character vector.

+
basedir

Length one character vector holding the directory where the file came from.

+ +
zipfile

If not null, giving the path to the zip file from which the file was read.

segment

Length one integer, specifying for which segment the cwa data were read.

+
substance

The TOXSWA name of the substance.

+
cwas

Dataframe holding the concentrations.

events

List of dataframes holding the event statistics for each threshold.

@@ -166,8 +161,7 @@ for the requested moving window sizes in days.

Method new()

- -

Usage

+

Create a TOXSWA_cwa object from a file

Usage

TOXSWA_cwa$new(
   filename,
   basedir,
@@ -177,22 +171,52 @@ for the requested moving window sizes in days.

   total = FALSE
 )

+

Arguments

+

+
filename

The filename

+ +
basedir

The directory to look in

+ +
zipfile

Optional path to a zipfile holding the file

+ +
segment

Either "last" or the number of the segment for which to read the data

+ +
substance

The TOXSWA substance name (for TOXSWA 4 or higher)

+ +
total

Should total concentrations be read in? If FALSE, free concentrations are read

+ +

Method moving_windows()

- -

Usage

+

Add to the `windows` field described above.

Usage

TOXSWA_cwa$moving_windows(windows, total = FALSE)

+

Arguments

+

+
windows

Window sizes in days

+ +
total

If TRUE, the total concentration including the amount adsorbed to +suspended matter will be used.

+ +

Method get_events()

- -

Usage

+

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

If TRUE, the total concentration including the amount adsorbed to +suspended matter will be used.

+ +

Method print()

- -

Usage

+

Print a `TOXSWA_cwa` object

Usage

TOXSWA_cwa$print()

-- cgit v1.2.1