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/plot.TOXSWA_cwa.html | 258 ++++++++++++++---------------------- 1 file changed, 99 insertions(+), 159 deletions(-) (limited to 'docs/reference/plot.TOXSWA_cwa.html') diff --git a/docs/reference/plot.TOXSWA_cwa.html b/docs/reference/plot.TOXSWA_cwa.html index 1262c71..857b154 100644 --- a/docs/reference/plot.TOXSWA_cwa.html +++ b/docs/reference/plot.TOXSWA_cwa.html @@ -1,65 +1,13 @@ - - - - - - - -Plot TOXSWA surface water concentrations — plot.TOXSWA_cwa • pfm - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Plot TOXSWA surface water concentrations — plot.TOXSWA_cwa • pfm - - - - + + -
-
- -
- -
+

Plot TOXSWA surface water concentrations

@@ -111,106 +45,112 @@ segment of a TOXSWA surface water body." /> segment of a TOXSWA surface water body.

- 
# S3 method for TOXSWA_cwa
-plot(
-  x,
-  time_column = c("datetime", "t", "t_firstjan", "t_rel_to_max"),
-  xlab = "default",
-  ylab = "default",
-  add = FALSE,
-  threshold_factor = 1000,
-  thin_low = 1,
-  total = FALSE,
-  LC_TIME = "C",
-  ...
-)
- -

Arguments

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
x

The TOXSWA_cwa object to be plotted.

time_column

What should be used for the time axis. If "t_firstjan" is chosen, -the time is given in days relative to the first of January in the first year.

xlab, ylab

Labels for x and y axis.

add

Should we add to an existing plot?

threshold_factor

The factor by which the data have to be lower than the maximum -in order to get thinned for plotting (see next argument).

thin_low

If an integer greater than 1, the data close to zero (smaller than +

+ 
# S3 method for TOXSWA_cwa
+plot(
+  x,
+  time_column = c("datetime", "t", "t_firstjan", "t_rel_to_max"),
+  xlab = "default",
+  ylab = "default",
+  add = FALSE,
+  threshold_factor = 1000,
+  thin_low = 1,
+  total = FALSE,
+  LC_TIME = "C",
+  ...
+)
+
+ +
+

Arguments

+
x
+

The TOXSWA_cwa object to be plotted.

+ + +
time_column
+

What should be used for the time axis. If "t_firstjan" is chosen, +the time is given in days relative to the first of January in the first year.

+ + +
xlab, ylab
+

Labels for x and y axis.

+ + +
add
+

Should we add to an existing plot?

+ + +
threshold_factor
+

The factor by which the data have to be lower than the maximum +in order to get thinned for plotting (see next argument).

+ + +
thin_low
+

If an integer greater than 1, the data close to zero (smaller than 1/threshold_factor of the maximum) in the series will be thinned by this factor -in order to decrease the amount of data that is included in the plots

total

Should the total concentration in water be plotted, including substance sorbed -to suspended matter?

LC_TIME

Specification of the locale used to format dates

...

Further arguments passed to plot if we are not adding to an existing plot

- - -

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"))
-plot(H_sw_D4_pond)
plot(H_sw_D4_pond, time_column = "t")
plot(H_sw_D4_pond, time_column = "t_firstjan")
plot(H_sw_D4_pond, time_column = "t_rel_to_max")

-H_sw_R1_stream  <- read.TOXSWA_cwa("00003s_pa.cwa",
-  basedir = "SwashProjects/project_H_sw/TOXSWA",
-  zipfile = system.file("testdata/SwashProjects.zip", package = "pfm"))
-plot(H_sw_R1_stream, time_column = "t_rel_to_max")
-
- +

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"))
+plot(H_sw_D4_pond)
+
+plot(H_sw_D4_pond, time_column = "t")
+
+plot(H_sw_D4_pond, time_column = "t_firstjan")
+
+plot(H_sw_D4_pond, time_column = "t_rel_to_max")
+
+
+H_sw_R1_stream  <- read.TOXSWA_cwa("00003s_pa.cwa",
+  basedir = "SwashProjects/project_H_sw/TOXSWA",
+  zipfile = system.file("testdata/SwashProjects.zip", package = "pfm"))
+plot(H_sw_R1_stream, time_column = "t_rel_to_max")
+
+
+
+
-
- - + + -- cgit v1.2.1