Retrieve endpoint information from the chyaml field of a chent object
Source:R/endpoint.R
endpoint.Rd
R6 class objects of class 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.
Usage
>>>>>>> refs/remotes/origin/mainendpoint(
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
=======Arguments
>>>>>>> refs/remotes/origin/main- chent
The chent object to get the information from
- medium
The medium for which information is sought
- type
The information type
- lab_field
If not NA, do we want laboratory or field endpoints
- redox
If not NA, are we looking for aerobic or anaerobic data
- value <<<<<<< HEAD
The name of the value we want. The list given in the =======
The name of the value we want. The list given in the >>>>>>> refs/remotes/origin/main usage section is not exclusive
- aggregator <<<<<<< HEAD
The aggregator function. Can be mean, =======
The aggregator function. Can be mean, >>>>>>> refs/remotes/origin/main
geomean
, or identity, for example.- raw
Should the number(s) be returned as stored in the chent object (could be a character value) to retain original information about precision?
- signif
How many significant digits do we want
- values
The values to be returned
- 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.