From 53099978c971ee8e5c94e67bf972f51629d67fd3 Mon Sep 17 00:00:00 2001
From: Johannes Ranke <jranke@uni-bremen.de>
Date: Thu, 11 Jun 2015 10:04:22 +0200
Subject: and the incomplete documentation

---
 pkg/man/PEC_soil_product.Rd | 17 +++++++++++++++++
 pkg/man/pfm_ai.Rd           | 24 ++++++++++++++++++++++++
 pkg/man/pfm_chent.Rd        | 34 ++++++++++++++++++++++++++++++++++
 pkg/man/pfm_product.Rd      | 26 ++++++++++++++++++++++++++
 4 files changed, 101 insertions(+)
 create mode 100644 pkg/man/PEC_soil_product.Rd
 create mode 100644 pkg/man/pfm_ai.Rd
 create mode 100644 pkg/man/pfm_chent.Rd
 create mode 100644 pkg/man/pfm_product.Rd

(limited to 'pkg')

diff --git a/pkg/man/PEC_soil_product.Rd b/pkg/man/PEC_soil_product.Rd
new file mode 100644
index 0000000..b4ea95e
--- /dev/null
+++ b/pkg/man/PEC_soil_product.Rd
@@ -0,0 +1,17 @@
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
+% Please edit documentation in R/PEC_soil.R
+\name{PEC_soil_product}
+\alias{PEC_soil_product}
+\title{Calculate predicted environmental concentrations in soil for a product}
+\usage{
+PEC_soil_product(product, rate, rate_units = "L/ha", interception = 0,
+  mixing_depth = 5, tillage_depth = 20, interval = 365,
+  bulk_density = 1.5, PEC_units = "mg/kg")
+}
+\description{
+Calculates long term accumulation PEC values
+}
+\author{
+Johannes Ranke
+}
+
diff --git a/pkg/man/pfm_ai.Rd b/pkg/man/pfm_ai.Rd
new file mode 100644
index 0000000..794a55e
--- /dev/null
+++ b/pkg/man/pfm_ai.Rd
@@ -0,0 +1,24 @@
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
+% Please edit documentation in R/pfm_chent.R
+\docType{class}
+\name{pfm_ai}
+\alias{pfm_ai}
+\title{R6 class for holding active ingredients}
+\format{An \code{\link{R6Class}} generator object.}
+\usage{
+pfm_ai
+}
+\description{
+An R6 class for holding information about active ingredients
+}
+\section{Fields}{
+
+\describe{
+\item{\code{iso}}{ISO common name}
+}}
+\examples{
+atrazine  <- pfm_ai("atrazine", smiles = "Clc1nc(nc(n1)NC(C)C)NCC", mw = 215.68)
+print(atrazine)
+}
+\keyword{data}
+
diff --git a/pkg/man/pfm_chent.Rd b/pkg/man/pfm_chent.Rd
new file mode 100644
index 0000000..c62e8cf
--- /dev/null
+++ b/pkg/man/pfm_chent.Rd
@@ -0,0 +1,34 @@
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
+% Please edit documentation in R/pfm_chent.R
+\docType{class}
+\name{pfm_chent}
+\alias{pfm_chent}
+\title{R6 class for holding a chemical entity}
+\format{An \code{\link{R6Class}} generator object.}
+\usage{
+pfm_chent
+}
+\description{
+An R6 class for holding information about a chemical entity
+}
+\section{Fields}{
+
+\describe{
+\item{\code{acronym}}{Acronym for local use}
+
+\item{\code{smiles}}{SMILES code}
+
+\item{\code{mw}}{Molecular weight}
+
+\item{\code{main_source}}{Main source of information}
+
+\item{\code{transformations}}{}
+
+\item{\code{sorption_endpoints}}{}
+}}
+\examples{
+atrazine  <- pfm_chent("atrazine", smiles = "Clc1nc(nc(n1)NC(C)C)NCC", mw = 215.68)
+print(atrazine)
+}
+\keyword{data}
+
diff --git a/pkg/man/pfm_product.Rd b/pkg/man/pfm_product.Rd
new file mode 100644
index 0000000..862ce3c
--- /dev/null
+++ b/pkg/man/pfm_product.Rd
@@ -0,0 +1,26 @@
+% Generated by roxygen2 (4.1.0.9001): do not edit by hand
+% Please edit documentation in R/pfm_chent.R
+\docType{class}
+\name{pfm_product}
+\alias{pfm_product}
+\title{R6 class for holding a product with at least one active ingredient}
+\format{An \code{\link{R6Class}} generator object.}
+\usage{
+pfm_product
+}
+\description{
+An R6 class for holding information about a product with at least one active ingredient
+}
+\section{Fields}{
+
+\describe{
+\item{\code{name}}{The name of the product}
+
+\item{\code{ais}}{A list of active ingredients}
+
+\item{\code{concentrations}}{The concentration of the ais}
+
+\item{\code{concentration_units}}{Defaults to g/L}
+}}
+\keyword{data}
+
-- 
cgit v1.2.1