From 2f618da8cfbeb0379f4d38af6f608a69c6d54bd5 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Sat, 30 Jul 2016 11:29:09 +0200 Subject: Update static documentation --- pkg/inst/web/read.TOXSWA_cwa.html | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'pkg/inst/web/read.TOXSWA_cwa.html') diff --git a/pkg/inst/web/read.TOXSWA_cwa.html b/pkg/inst/web/read.TOXSWA_cwa.html index 5542fca..3f2d997 100644 --- a/pkg/inst/web/read.TOXSWA_cwa.html +++ b/pkg/inst/web/read.TOXSWA_cwa.html @@ -2,7 +2,7 @@ -read.TOXSWA_cwa. pfm 0.3-1 +read.TOXSWA_cwa. pfm 0.3-7
- pfm 0.3-1 + pfm 0.3-7
  • Index
    • @@ -54,12 +54,13 @@ Johannes Ranke

    Usage

    - 
    read.TOXSWA_cwa(filename, basedir = ".", zipfile = NULL, segment = "last", windows = NULL, thresholds = NULL)
    + 
    read.TOXSWA_cwa(filename, basedir = ".", zipfile = NULL, segment = "last", substance = "parent", total = FALSE, windows = NULL, thresholds = NULL)

    Arguments

    filename
    -
    The filename of the cwa file.
    +
    The filename of the cwa file (TOXSWA 2.x.y or similar) or the +out file (FOCUS TOXSWA 4, i.e. TOXSWA 4.4.2 or similar).
    basedir
    The path to the directory where the cwa file resides.
    zipfile
    @@ -67,6 +68,14 @@ Johannes Ranke
    segment
    The segment for which the data should be read. Either "last", or the segment number.
    +
    substance
    +
    For TOXSWA 4 .out files, the default value "parent" leads +to reading concentrations of the parent compound. Alternatively, the substance +of interested can be selected by its code name.
    +
    total
    +
    Set this to TRUE in order to read total concentrations as well. This is +only necessary for .out files as generated by TOXSWA 4.4.2 or similar, not for .cwa +files. For .cwa files, the total concentration is always read as well.
    windows
    Numeric vector of width of moving windows in days, for calculating maximum time weighted average concentrations and areas under the curve.
    @@ -90,7 +99,9 @@ An instance of an R6 object of class

    Read TOXSWA hourly concentrations of a chemical substance in a specific segment of a TOXSWA surface water body. Per default, the data for the last -segment are imported.

    +segment are imported. As TOXSWA 4 reports the values at the end of the hour +(ConLiqWatLayCur) in its summary file, we use this value as well instead +of the hourly averages (ConLiqWatLay).

    -- cgit v1.2.3