From ffeec05d913f2e987da362c05df2afc2a8a23965 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Mon, 29 Jan 2018 10:11:27 +0100 Subject: Documentation fixes and updates --- man/TOXSWA_cwa.Rd | 4 ++-- man/perc_runoff_exposit.Rd | 6 ------ man/perc_runoff_reduction_exposit.Rd | 3 +-- man/read.TOXSWA_cwa.Rd | 2 +- 4 files changed, 4 insertions(+), 11 deletions(-) (limited to 'man') diff --git a/man/TOXSWA_cwa.Rd b/man/TOXSWA_cwa.Rd index e417094..3152c6e 100644 --- a/man/TOXSWA_cwa.Rd +++ b/man/TOXSWA_cwa.Rd @@ -26,7 +26,7 @@ Usually, an instance of this class will be generated by \code{\link{read.TOXSWA_ \item{\code{events}}{List of dataframes holding the event statistics for each threshold.} \item{\code{windows}}{Matrix of maximum time weighted average concentrations (TWAC_max) -and areas under the curve in \u00B5g/day * h (AUC_max_h) or \u00B5g/day * d (AUC_max_d) +and areas under the curve in µg/day * h (AUC_max_h) or µg/day * d (AUC_max_d) for the requested moving window sizes in days.} }} @@ -35,7 +35,7 @@ for the requested moving window sizes in days.} \describe{ \item{\code{get_events(threshold, total = FALSE)}}{ Populate a datataframe with event information for the specified threshold value - in \u00B5g/L. If \code{total = TRUE}, the total concentration including the amount + in µg/L. If \code{total = TRUE}, the total concentration including the amount adsorbed to suspended matter will be used. The resulting dataframe is stored in the \code{events} field of the object. } diff --git a/man/perc_runoff_exposit.Rd b/man/perc_runoff_exposit.Rd index 70f80c5..4f460e4 100644 --- a/man/perc_runoff_exposit.Rd +++ b/man/perc_runoff_exposit.Rd @@ -1,9 +1,7 @@ % Generated by roxygen2: do not edit by hand % Please edit documentation in R/PEC_sw_exposit_runoff.R -\docType{data} \name{perc_runoff_exposit} \alias{perc_runoff_exposit} -\alias{Koc_breaks} \title{Runoff loss percentages as used in Exposit 3} \format{A data frame with percentage values for the dissolved fraction and the fraction bound to eroding particles, with Koc classes used as row names @@ -17,13 +15,9 @@ Excel 3.01 spreadsheet available from \url{https://www.bvl.bund.de/DE/04_Pflanzenschutzmittel/03_Antragsteller/04_Zulassungsverfahren/07_Naturhaushalt/psm_naturhaush_node.html#doc1400590bodyText3} } -\usage{ -Koc_breaks -} \description{ A table of the loss percentages used in Exposit 3 for the twelve different Koc classes } \examples{ print(perc_runoff_exposit) } -\keyword{datasets} diff --git a/man/perc_runoff_reduction_exposit.Rd b/man/perc_runoff_reduction_exposit.Rd index 51b067d..bc93b29 100644 --- a/man/perc_runoff_reduction_exposit.Rd +++ b/man/perc_runoff_reduction_exposit.Rd @@ -3,7 +3,6 @@ \docType{data} \name{perc_runoff_reduction_exposit} \alias{perc_runoff_reduction_exposit} -\alias{buffers} \title{Runoff reduction percentages as used in Exposit} \format{A named list of data frames with reduction percentage values for the dissolved fraction and the fraction bound to eroding particles, with @@ -18,7 +17,7 @@ Excel 3.01 spreadsheet available from \url{https://www.bvl.bund.de/DE/04_Pflanzenschutzmittel/03_Antragsteller/04_Zulassungsverfahren/07_Naturhaushalt/psm_naturhaush_node.html#doc1400590bodyText3} } \usage{ -buffers +perc_runoff_reduction_exposit } \description{ A table of the runoff reduction percentages used in Exposit 3 for different vegetated buffer widths diff --git a/man/read.TOXSWA_cwa.Rd b/man/read.TOXSWA_cwa.Rd index 28479f2..2541c9b 100644 --- a/man/read.TOXSWA_cwa.Rd +++ b/man/read.TOXSWA_cwa.Rd @@ -30,7 +30,7 @@ files. For .cwa files, the total concentration is always read as well.} \item{windows}{Numeric vector of width of moving windows in days, for calculating maximum time weighted average concentrations and areas under the curve.} -\item{thresholds}{Numeric vector of threshold concentrations in \u00B5g/L for +\item{thresholds}{Numeric vector of threshold concentrations in µg/L for generating event statistics.} } \value{ -- cgit v1.2.1