Some documentation updates

Document that TOXSWA 5.5.3 is supported in the help files

2 files changed, 8 insertions, 7 deletions

diff --git a/R/PEC_soil.R b/R/PEC_soil.R
index ea1cb71..15ccc90 100644
--- a/R/PEC_soil.R
+++ b/R/PEC_soil.R
@@ -1,4 +1,4 @@
-# Copyright (C) 2015  Johannes Ranke
+# Copyright (C) 2015,2016,2018  Johannes Ranke
 # Contact: jranke@uni-bremen.de
 # This file is part of the R package pfm
 
@@ -44,7 +44,7 @@ if(getRversion() >= '2.15.1') utils::globalVariables(c("destination", "study_typ
 #' @param interception The fraction of the application rate that does not reach the soil
 #' @param mixing_depth Mixing depth in cm
 #' @param 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
 #' @param n_periods Number of periods to be considered for long term PEC calculations
 #' @param PEC_units Requested units for the calculated PEC. Only mg/kg currently supported
 #' @param PEC_pw_units Only mg/L currently supported
diff --git a/R/TOXSWA_cwa.R b/R/TOXSWA_cwa.R
index 576c7d3..5b1e8f2 100644
--- a/R/TOXSWA_cwa.R
+++ b/R/TOXSWA_cwa.R
@@ -22,10 +22,11 @@ if(getRversion() >= '2.15.1') utils::globalVariables(c("cwa"))
 #' 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.
 #'
 #' @param 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.
 #' @param basedir The path to the directory where the cwa file resides.
 #' @param zipfile Optional path to a zip file containing the cwa file.
 #' @param segment The segment for which the data should be read. Either "last", or
@@ -33,7 +34,7 @@ if(getRversion() >= '2.15.1') utils::globalVariables(c("cwa"))
 #' @param 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.
-#' @param substance For TOXSWA 4 .out files, the default value "parent" leads
+#' @param 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.
 #' @param windows Numeric vector of width of moving windows in days, for calculating
@@ -155,9 +156,9 @@ plot.TOXSWA_cwa <- function(x, time_column = c("datetime", "t", "t_firstjan", "t
   tmp <- Sys.setlocale("LC_TIME", lct)
 }
 
-#' R6 class for holding TOXSWA cwa concentration data and associated statistics
+#' R6 class for holding TOXSWA water concentration data and associated statistics
 #'
-#' 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}}.
 #'
 #' @docType class