From d66bd4aa0bf9c4d9b8793a4e308c9e80691b440f Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Sun, 12 Nov 2023 21:40:01 +0100 Subject: Enable links to source, upgrade to bootstrap 5 --- docs/reference/endpoint.html | 342 +++++++++++++++++-------------------------- 1 file changed, 137 insertions(+), 205 deletions(-) (limited to 'docs/reference/endpoint.html') diff --git a/docs/reference/endpoint.html b/docs/reference/endpoint.html index 39071ee..5e038b1 100644 --- a/docs/reference/endpoint.html +++ b/docs/reference/endpoint.html @@ -1,250 +1,182 @@ - - - - - - +Retrieve endpoint information from the chyaml field of a chent object — endpoint • pfm + Skip to contents + -Retrieve endpoint information from the chyaml field of a chent object — endpoint • pfm +
+
+
+

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

+ 
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

+
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
+

The name of the value we want. The list given in the +usage section is not exclusive

- -
+
aggregator
+

The aggregator function. Can be mean, +geomean, or identity, for example.

-
-
-
-

Retrieve endpoint information from the chyaml field of a chent object

- - -
-
-

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.

-
- - 
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

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
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

The name of the value we want. The list given in the -usage section is not exclusive

aggregator

The aggregator function. Can be mean, -geomean, or identity, for example.

raw

Should the number(s) be returned as stored in the chent +

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 +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.

-

Details

- +
+
+

Details

The functions soil_* are functions to extract soil specific endpoints. For the Freundlich exponent, the capital letter N is used in order to facilitate dealing with such data in R. In pesticide fate modelling, this exponent is often called 1/n.

+
-
- -
- - - + - - - + -- cgit v1.2.1 From 4079a2c496aa4e8c6dc2a93afedcbedbf7a852b5 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Sun, 12 Nov 2023 21:59:34 +0100 Subject: Enable markdown and rebuild docs --- docs/reference/endpoint.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/reference/endpoint.html') diff --git a/docs/reference/endpoint.html b/docs/reference/endpoint.html index 5e038b1..b17611e 100644 --- a/docs/reference/endpoint.html +++ b/docs/reference/endpoint.html @@ -115,12 +115,12 @@ this function.

value
-

The name of the value we want. The list given in the +

The name of the value we want. The list given in the usage section is not exclusive

aggregator
-

The aggregator function. Can be mean, +

The aggregator function. Can be mean, geomean, or identity, for example.

@@ -147,10 +147,10 @@ about precision?

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.

+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.

Details

-- cgit v1.2.1