Update static docs

1 files changed, 93 insertions, 0 deletions

diff --git a/docs/reference/plot.TOXSWA_cwa.md b/docs/reference/plot.TOXSWA_cwa.md
new file mode 100644
index 0000000..1f5f07f
--- /dev/null
+++ b/docs/reference/plot.TOXSWA_cwa.md
@@ -0,0 +1,93 @@
+# Plot TOXSWA surface water concentrations
+
+Plot TOXSWA hourly concentrations of a chemical substance in a specific
+segment of a TOXSWA surface water body.
+
+## Usage
+
+``` r
+# S3 method for class '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
+
+## Author
+
+Johannes Ranke
+
+## Examples
+
+``` r
+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")
+```