From ec79637749d300ab4ca170805c673905e52d67dd Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Wed, 22 Apr 2015 13:42:10 +0200
Subject: Add simplest PEC soil calcs, use testthat

---
 pkg/man/PEC_soil.Rd        | 36 ++++++++++++++++++++++++++++++++++++
 pkg/man/TOXSWA_cwa.Rd      |  2 +-
 pkg/man/plot.TOXSWA_cwa.Rd |  2 +-
 pkg/man/read.TOXSWA_cwa.Rd |  2 +-
 4 files changed, 39 insertions(+), 3 deletions(-)
 create mode 100644 pkg/man/PEC_soil.Rd

(limited to 'pkg/man')

diff --git a/pkg/man/PEC_soil.Rd b/pkg/man/PEC_soil.Rd
new file mode 100644
index 0000000..76ffd4b
--- /dev/null
+++ b/pkg/man/PEC_soil.Rd
@@ -0,0 +1,36 @@
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
+% Please edit documentation in R/PEC_soil.R
+\name{PEC_soil}
+\alias{PEC_soil}
+\title{Calculate predicted environmental concentrations in soil}
+\usage{
+PEC_soil(rate, rate_units = "g/ha", interception = 0, mixing_depth = 5,
+  bulk_density = 1.5, PEC_units = "mg/kg")
+}
+\arguments{
+\item{rate}{Application rate in units specified below}
+
+\item{rate_units}{Defaults to g/ha}
+
+\item{interception}{The fraction of the application rate that does not reach the soil}
+
+\item{mixing_depth}{Mixing depth in cm}
+
+\item{bulk_density}{Bulk density of the soil. Defaults to 1.5 kg/L, or 1500 kg/m3}
+
+\item{PEC_units}{Requested units for the calculated PEC. Only mg/kg currently supported}
+}
+\value{
+The predicted concentration in soil
+}
+\description{
+This is a basic, vectorised form of a simple calculation of a contaminant
+concentration in bulk soil based on complete, instantaneous mixing.
+}
+\examples{
+PEC_soil(100, interception = 0.25)
+}
+\author{
+Johannes Ranke
+}
+
diff --git a/pkg/man/TOXSWA_cwa.Rd b/pkg/man/TOXSWA_cwa.Rd
index c4d573b..5aa8bfc 100644
--- a/pkg/man/TOXSWA_cwa.Rd
+++ b/pkg/man/TOXSWA_cwa.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
 % Please edit documentation in R/TOXSWA_cwa.R
 \docType{class}
 \name{TOXSWA_cwa}
diff --git a/pkg/man/plot.TOXSWA_cwa.Rd b/pkg/man/plot.TOXSWA_cwa.Rd
index 9136c10..1dddb78 100644
--- a/pkg/man/plot.TOXSWA_cwa.Rd
+++ b/pkg/man/plot.TOXSWA_cwa.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
 % Please edit documentation in R/TOXSWA_cwa.R
 \name{plot.TOXSWA_cwa}
 \alias{plot.TOXSWA_cwa}
diff --git a/pkg/man/read.TOXSWA_cwa.Rd b/pkg/man/read.TOXSWA_cwa.Rd
index ded0a39..f67455f 100644
--- a/pkg/man/read.TOXSWA_cwa.Rd
+++ b/pkg/man/read.TOXSWA_cwa.Rd
@@ -1,4 +1,4 @@
-% Generated by roxygen2 (4.1.0): do not edit by hand
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
 % Please edit documentation in R/TOXSWA_cwa.R
 \name{read.TOXSWA_cwa}
 \alias{read.TOXSWA_cwa}
-- 
cgit v1.2.1