diff options
author | Johannes Ranke <jranke@uni-bremen.de> | 2015-10-15 14:41:26 +0200 |
---|---|---|
committer | Johannes Ranke <jranke@uni-bremen.de> | 2015-10-15 21:12:08 +0200 |
commit | 6b4e342b240baaf18150360986d15895fc80a937 (patch) | |
tree | b9664e0970280bbebb8e3fc13b59f3920c86d4e5 /pkg/man/endpoint.Rd | |
parent | c43b4947007b3c26bc56260499af51c41b8cd702 (diff) |
Add endpoint and GUS functions, roxygenize
Diffstat (limited to 'pkg/man/endpoint.Rd')
-rw-r--r-- | pkg/man/endpoint.Rd | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/pkg/man/endpoint.Rd b/pkg/man/endpoint.Rd new file mode 100644 index 0000000..6c93022 --- /dev/null +++ b/pkg/man/endpoint.Rd @@ -0,0 +1,45 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/endpoint.R +\name{endpoint} +\alias{endpoint} +\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) +} +\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{signif}{How many significant digits do we want} +} +\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. +} + |