aboutsummaryrefslogtreecommitdiff
path: root/pkg/man
diff options
context:
space:
mode:
Diffstat (limited to 'pkg/man')
-rw-r--r--pkg/man/TOXSWA_cwa.Rd5
-rw-r--r--pkg/man/plot.TOXSWA_cwa.Rd3
-rw-r--r--pkg/man/read.TOXSWA_cwa.Rd15
3 files changed, 15 insertions, 8 deletions
diff --git a/pkg/man/TOXSWA_cwa.Rd b/pkg/man/TOXSWA_cwa.Rd
index 73491ce..c4d573b 100644
--- a/pkg/man/TOXSWA_cwa.Rd
+++ b/pkg/man/TOXSWA_cwa.Rd
@@ -47,9 +47,12 @@ for the requested moving window sizes in days.}
}
\examples{
H_sw_R1_stream <- read.TOXSWA_cwa("00003s_pa.cwa",
- system.file("testdata/SwashProjects/project_H_sw/TOXSWA",
+ 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}
diff --git a/pkg/man/plot.TOXSWA_cwa.Rd b/pkg/man/plot.TOXSWA_cwa.Rd
index 7f841b7..640f65d 100644
--- a/pkg/man/plot.TOXSWA_cwa.Rd
+++ b/pkg/man/plot.TOXSWA_cwa.Rd
@@ -31,7 +31,8 @@ segment of a segment of a TOXSWA surface water body.
}
\examples{
H_sw_D4_pond <- read.TOXSWA_cwa("00001p_pa.cwa",
- system.file("testdata/SwashProjects/project_H_sw/TOXSWA",
+ basedir = "SwashProjects/project_H_sw/TOXSWA",
+ zipfile = system.file("testdata/SwashProjects.zip",
package = "pfm"))
plot(H_sw_D4_pond)
}
diff --git a/pkg/man/read.TOXSWA_cwa.Rd b/pkg/man/read.TOXSWA_cwa.Rd
index bb00dcd..ded0a39 100644
--- a/pkg/man/read.TOXSWA_cwa.Rd
+++ b/pkg/man/read.TOXSWA_cwa.Rd
@@ -4,19 +4,21 @@
\alias{read.TOXSWA_cwa}
\title{Read TOXSWA surface water concentrations}
\usage{
-read.TOXSWA_cwa(filename, basedir = ".", segment = "last", windows = c(7,
- 21), thresholds = NULL)
+read.TOXSWA_cwa(filename, basedir = ".", zipfile = NULL, segment = "last",
+ windows = NULL, 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{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{windows}{Numeric vector of width of moving windows for calculating
-time weighted average concentrations and areas under the curve.}
+\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.}
@@ -32,7 +34,8 @@ segment are imported.
}
\examples{
H_sw_D4_pond <- read.TOXSWA_cwa("00001p_pa.cwa",
- system.file("testdata/SwashProjects/project_H_sw/TOXSWA",
+ basedir = "SwashProjects/project_H_sw/TOXSWA",
+ zipfile = system.file("testdata/SwashProjects.zip",
package = "pfm"))
}
\author{

Contact - Imprint