Reorganise repository using standard package layout

1 files changed, 42 insertions, 0 deletions

diff --git a/man/PEC_sw_sed.Rd b/man/PEC_sw_sed.Rd
new file mode 100644
index 0000000..3140eb0
--- /dev/null
+++ b/man/PEC_sw_sed.Rd
@@ -0,0 +1,42 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/PEC_sw_sed.R
+\name{PEC_sw_sed}
+\alias{PEC_sw_sed}
+\title{Calculate predicted environmental concentrations in sediment from surface
+water concentrations}
+\usage{
+PEC_sw_sed(PEC_sw, percentage = 100, method = "percentage",
+  sediment_depth = 5, water_depth = 30, sediment_density = 1.3,
+  PEC_sed_units = c("µg/kg", "mg/kg"))
+}
+\arguments{
+\item{PEC_sw}{Numeric vector or matrix of surface water concentrations in µg/L for
+which the corresponding sediment concentration is to be estimated}
+
+\item{percentage}{The percentage in sediment, used for the percentage method}
+
+\item{method}{The method used for the calculation}
+
+\item{sediment_depth}{Depth of the sediment layer}
+
+\item{water_depth}{Depth of the water body in cm}
+
+\item{sediment_density}{The density of the sediment in L/kg (equivalent to
+g/cm3)}
+
+\item{PEC_sed_units}{The units of the estimated sediment PEC value}
+}
+\value{
+The predicted concentration in sediment
+}
+\description{
+The method 'percentage' is equivalent to what is used in the CRD spreadsheet
+PEC calculator
+}
+\examples{
+PEC_sw_sed(PEC_sw_drift(100, distances = 1), percentage = 50)
+}
+\author{
+Johannes Ranke
+}
+