aboutsummaryrefslogtreecommitdiff
path: root/pkg/man/read.TOXSWA_cwa.Rd
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2016-09-27 23:00:48 +0200
committerJohannes Ranke <jranke@uni-bremen.de>2016-09-27 23:00:48 +0200
commit12a31f4c130c551f82232d9ef7dfb608bd52c53f (patch)
tree2525ab1ea4102a6edddbd0c2f03f4a851bf2f9c5 /pkg/man/read.TOXSWA_cwa.Rd
parent0d958ab6f84b569b5437f231c56004890c4ae23b (diff)
Reorganise repository using standard package layout
Diffstat (limited to 'pkg/man/read.TOXSWA_cwa.Rd')
-rw-r--r--pkg/man/read.TOXSWA_cwa.Rd56
1 files changed, 0 insertions, 56 deletions
diff --git a/pkg/man/read.TOXSWA_cwa.Rd b/pkg/man/read.TOXSWA_cwa.Rd
deleted file mode 100644
index 84ef3da..0000000
--- a/pkg/man/read.TOXSWA_cwa.Rd
+++ /dev/null
@@ -1,56 +0,0 @@
-% Generated by roxygen2: 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 = ".", zipfile = NULL, segment = "last",
- substance = "parent", total = FALSE, windows = NULL,
- thresholds = NULL)
-}
-\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).}
-
-\item{basedir}{The path to the directory where the cwa file resides.}
-
-\item{zipfile}{Optional path to a zip file containing the cwa file.}
-
-\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
-to reading concentrations of the parent compound. Alternatively, the substance
-of interested can be selected by its code name.}
-
-\item{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.}
-
-\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 µ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. 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).
-}
-\examples{
-H_sw_D4_pond <- read.TOXSWA_cwa("00001p_pa.cwa",
- basedir = "SwashProjects/project_H_sw/TOXSWA",
- zipfile = system.file("testdata/SwashProjects.zip",
- package = "pfm"))
-}
-\author{
-Johannes Ranke
-}
-

Contact - Imprint