Initial commit: R6 class for TOXSWA cwa files

1 files changed, 41 insertions, 0 deletions

diff --git a/pkg/man/read.TOXSWA_cwa.Rd b/pkg/man/read.TOXSWA_cwa.Rd
new file mode 100644
index 0000000..bb00dcd
--- /dev/null
+++ b/pkg/man/read.TOXSWA_cwa.Rd
@@ -0,0 +1,41 @@
+% Generated by roxygen2 (4.1.0): do not edit by hand
+% Please edit documentation in R/TOXSWA_cwa.R
+\name{read.TOXSWA_cwa}
+\alias{read.TOXSWA_cwa}
+\title{Read TOXSWA surface water concentrations}
+\usage{
+read.TOXSWA_cwa(filename, basedir = ".", segment = "last", windows = c(7,
+  21), thresholds = NULL)
+}
+\arguments{
+\item{filename}{The filename of the cwa file.}
+
+\item{basedir}{The full path to the directory where the cwa file resides.}
+
+\item{segment}{The segment for which the data should be read. Either "last", or
+the segment number.}
+
+\item{windows}{Numeric vector of width of moving windows for calculating
+time weighted average concentrations and areas under the curve.}
+
+\item{thresholds}{Numeric vector of threshold concentrations in µg/L for
+generating event statistics.}
+}
+\value{
+An instance of an R6 object of class
+\code{\link{TOXSWA_cwa}}.
+}
+\description{
+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.
+}
+\examples{
+H_sw_D4_pond  <- read.TOXSWA_cwa("00001p_pa.cwa",
+                                 system.file("testdata/SwashProjects/project_H_sw/TOXSWA",
+                                             package = "pfm"))
+}
+\author{
+Johannes Ranke
+}
+