aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2018-07-04 10:59:47 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2018-07-04 10:59:47 +0200
commit8989a484b9b2d23463c95e0a3927e307ec0a5e64 (patch)
treea8484fd03c325684fe61ee3b434de4b5ad5881cf /man
parent6ca8bdb8636141fac592688a6794ae092f0bc85a (diff)
Some documentation updates
Document that TOXSWA 5.5.3 is supported in the help files
Diffstat (limited to 'man')
-rw-r--r--man/PEC_soil.Rd2
-rw-r--r--man/TOXSWA_cwa.Rd4
-rw-r--r--man/read.TOXSWA_cwa.Rd7
3 files changed, 7 insertions, 6 deletions
diff --git a/man/PEC_soil.Rd b/man/PEC_soil.Rd
index dd780cf..1491790 100644
--- a/man/PEC_soil.Rd
+++ b/man/PEC_soil.Rd
@@ -24,7 +24,7 @@ PEC_soil(rate, rate_units = "g/ha", interception = 0, mixing_depth = 5,
\item{PEC_pw_units}{Only mg/L currently supported}
\item{interval}{Period of the deeper mixing, defaults to 365, which is a year if
-rate units are in days}
+degradation rate units are in days}
\item{n_periods}{Number of periods to be considered for long term PEC calculations}
diff --git a/man/TOXSWA_cwa.Rd b/man/TOXSWA_cwa.Rd
index 3152c6e..f073180 100644
--- a/man/TOXSWA_cwa.Rd
+++ b/man/TOXSWA_cwa.Rd
@@ -3,13 +3,13 @@
\docType{class}
\name{TOXSWA_cwa}
\alias{TOXSWA_cwa}
-\title{R6 class for holding TOXSWA cwa concentration data and associated statistics}
+\title{R6 class for holding TOXSWA water concentration data and associated statistics}
\format{An \code{\link{R6Class}} generator object.}
\usage{
TOXSWA_cwa
}
\description{
-An R6 class for holding TOXSWA cwa concentration data and some associated statistics.
+An R6 class for holding TOXSWA water concentration (cwa) data and some associated statistics.
Usually, an instance of this class will be generated by \code{\link{read.TOXSWA_cwa}}.
}
\section{Fields}{
diff --git a/man/read.TOXSWA_cwa.Rd b/man/read.TOXSWA_cwa.Rd
index 2541c9b..c76fdbd 100644
--- a/man/read.TOXSWA_cwa.Rd
+++ b/man/read.TOXSWA_cwa.Rd
@@ -10,7 +10,7 @@ read.TOXSWA_cwa(filename, basedir = ".", zipfile = NULL, segment = "last",
}
\arguments{
\item{filename}{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).}
+out file when using FOCUS TOXSWA 4 (i.e. TOXSWA 4.4.2) or higher.}
\item{basedir}{The path to the directory where the cwa file resides.}
@@ -19,7 +19,7 @@ out file (FOCUS TOXSWA 4, i.e. TOXSWA 4.4.2 or similar).}
\item{segment}{The segment for which the data should be read. Either "last", or
the segment number.}
-\item{substance}{For TOXSWA 4 .out files, the default value "parent" leads
+\item{substance}{For .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.}
@@ -42,7 +42,8 @@ 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. 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).
+of the hourly averages (ConLiqWatLay). In TOXSWA 5.5.3 this variable was
+renamed to ConLiqWatLay in the out file.
}
\examples{
H_sw_D4_pond <- read.TOXSWA_cwa("00001p_pa.cwa",

Contact - Imprint