aboutsummaryrefslogtreecommitdiff
path: root/pkg/man/endpoint.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/endpoint.Rd
parent0d958ab6f84b569b5437f231c56004890c4ae23b (diff)
Reorganise repository using standard package layout
Diffstat (limited to 'pkg/man/endpoint.Rd')
-rw-r--r--pkg/man/endpoint.Rd75
1 files changed, 0 insertions, 75 deletions
diff --git a/pkg/man/endpoint.Rd b/pkg/man/endpoint.Rd
deleted file mode 100644
index fd16650..0000000
--- a/pkg/man/endpoint.Rd
+++ /dev/null
@@ -1,75 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/endpoint.R
-\name{endpoint}
-\alias{endpoint}
-\alias{soil_DT50}
-\alias{soil_Kfoc}
-\alias{soil_N}
-\alias{soil_sorption}
-\title{Retrieve endpoint information from the chyaml field of a chent object}
-\usage{
-endpoint(chent, medium = "soil", type = c("degradation", "sorption"),
- lab_field = c(NA, "laboratory", "field"), redox = c(NA, "aerobic",
- "anaerobic"), value = c("DT50ref", "Kfoc", "N"), aggregator = geomean,
- raw = FALSE, signif = 3)
-
-soil_DT50(chent, aggregator = geomean, signif = 3,
- lab_field = "laboratory", value = "DT50ref", redox = "aerobic",
- raw = FALSE)
-
-soil_Kfoc(chent, aggregator = geomean, signif = 3, value = "Kfoc",
- raw = FALSE)
-
-soil_N(chent, aggregator = mean, signif = 3, raw = FALSE)
-
-soil_sorption(chent, values = c("Kfoc", "N"), aggregators = c(Kfoc =
- geomean, Koc = geomean, N = mean), signif = c(Kfoc = 3, N = 3),
- raw = FALSE)
-}
-\arguments{
-\item{chent}{The \code{\link{chent}} object to get the information from}
-
-\item{medium}{The medium for which information is sought}
-
-\item{type}{The information type}
-
-\item{lab_field}{If not NA, do we want laboratory or field endpoints}
-
-\item{redox}{If not NA, are we looking for aerobic or anaerobic data}
-
-\item{value}{The name of the value we want. The list given in the
-usage section is not exclusive}
-
-\item{aggregator}{The aggregator function. Can be mean,
-\code{\link{geomean}}, or identity, for example.}
-
-\item{raw}{Should the number(s) be returned as stored in the chent
-object (could be a character value) to retain original information
-about precision?}
-
-\item{signif}{How many significant digits do we want}
-
-\item{values}{The values to be returned}
-
-\item{aggregators}{A named vector of aggregator functions to be used}
-}
-\value{
-The result from applying the aggregator function to
- the values converted to a numeric vector, rounded to the
- given number of significant digits, or, if raw = TRUE,
- the values as a character value, retaining any implicit
- information on precision that may be present.
-}
-\description{
-R6 class objects of class \code{\link{chent}} represent chemical entities
-and can hold a list of information loaded from a chemical yaml file in their
-chyaml field. Such information is extracted and optionally aggregated by
-this function.
-}
-\details{
-The functions \code{soil_*} are functions to extract soil specific endpoints.
-For the Freundlich exponent, the capital letter \code{N} is used in order to
-facilitate dealing with such data in R. In pesticide fate modelling, this
-exponent is often called 1/n.
-}
-

Contact - Imprint