From 803fe13e505960fddccdbd4dcb524715f5eb068d Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Wed, 18 Sep 2019 18:18:40 +0200 Subject: Add url: tag to _pkgdown.yml, typo, update docs --- docs/reference/TOXSWA_cwa.html | 59 ++++++++++++++++++++++++++---------------- 1 file changed, 36 insertions(+), 23 deletions(-) (limited to 'docs/reference/TOXSWA_cwa.html') diff --git a/docs/reference/TOXSWA_cwa.html b/docs/reference/TOXSWA_cwa.html index d840e52..ab741ae 100644 --- a/docs/reference/TOXSWA_cwa.html +++ b/docs/reference/TOXSWA_cwa.html @@ -16,13 +16,15 @@ - + + - - + + + @@ -48,6 +50,7 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." /> + @@ -72,7 +75,7 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." /> @@ -95,13 +93,14 @@ Usually, an instance of this class will be generated by read.TOXSWA_cwa." /> +
@@ -121,21 +120,29 @@ Usually, an instance of this class will be generated by + +
filename

Length one character vector.

-
basedir

Length one character vector.

-
segment

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

-
cwas

Dataframe holding the concentrations.

-
events

List of dataframes holding the event statistics for each threshold.

-
windows

Matrix of maximum time weighted average concentrations (TWAC_max) + +

basedir

Length one character vector.

+ +
segment

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

+ +
cwas

Dataframe holding the concentrations.

+ +
events

List of dataframes holding the event statistics for each threshold.

+ +
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.

+

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 @@ -143,17 +150,19 @@ for the requested moving window sizes in days.

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.

+
+

Examples

H_sw_R1_stream <- read.TOXSWA_cwa("00003s_pa.cwa", basedir = "SwashProjects/project_H_sw/TOXSWA", - zipfile = system.file("testdata/SwashProjects.zip", + 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)
#> <TOXSWA_cwa> data from file 00003s_pa.cwa segment 20 +H_sw_R1_stream$get_events(c(2, 10)) +H_sw_R1_stream$moving_windows(c(7, 21)) +print(H_sw_R1_stream)
#> <TOXSWA_cwa> data from file 00003s_pa.cwa segment 20 #> datetime t t_firstjan t_rel_to_max cwa_mug_per_L #> 20 1978-10-01 00:00:00 0.000 273.0000 -55.333 0 #> 40 1978-10-01 01:00:00 0.042 273.0417 -55.291 0 @@ -196,19 +205,23 @@ for the requested moving window sizes in days.

+
-

Site built with pkgdown 1.3.0.

+

Site built with pkgdown 1.4.1.

+
+ + -- cgit v1.2.1