From 12a31f4c130c551f82232d9ef7dfb608bd52c53f Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Tue, 27 Sep 2016 23:00:48 +0200
Subject: Reorganise repository using standard package layout

---
 man/TOXSWA_cwa.Rd | 58 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 man/TOXSWA_cwa.Rd

(limited to 'man/TOXSWA_cwa.Rd')

diff --git a/man/TOXSWA_cwa.Rd b/man/TOXSWA_cwa.Rd
new file mode 100644
index 0000000..de87510
--- /dev/null
+++ b/man/TOXSWA_cwa.Rd
@@ -0,0 +1,58 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/TOXSWA_cwa.R
+\docType{class}
+\name{TOXSWA_cwa}
+\alias{TOXSWA_cwa}
+\title{R6 class for holding TOXSWA cwa 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.
+Usually, an instance of this class will be generated by \code{\link{read.TOXSWA_cwa}}.
+}
+\section{Fields}{
+
+\describe{
+\item{\code{filename}}{Length one character vector.}
+
+\item{\code{basedir}}{Length one character vector.}
+
+\item{\code{segment}}{Length one integer, specifying for which segment the cwa data were read.}
+
+\item{\code{cwas}}{Dataframe holding the concentrations.}
+
+\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 µg/day * h (AUC_max_h) or µg/day * d (AUC_max_d) 
+for the requested moving window sizes in days.}
+}}
+\section{Methods}{
+
+\describe{
+  \item{\code{get_events(threshold, total = FALSE)}}{
+        Populate a datataframe with event information for the specified threshold value
+        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.
+        }
+  \item{\code{moving_windows(windows, total = FALSE)}}{
+        Add to the \code{windows} field described above.
+        Again, if \code{total = TRUE}, the total concentration including the amount
+        adsorbed to suspended matter will be used.
+        }
+}
+}
+\examples{
+H_sw_R1_stream  <- read.TOXSWA_cwa("00003s_pa.cwa",
+                                 basedir = "SwashProjects/project_H_sw/TOXSWA",
+                                 zipfile = system.file("testdata/SwashProjects.zip",
+                                             package = "pfm"))
+H_sw_R1_stream$get_events(c(2, 10))
+H_sw_R1_stream$moving_windows(c(7, 21))
+print(H_sw_R1_stream)
+}
+\keyword{data}
+
-- 
cgit v1.2.1