From 4a918da6d5f971335b74b0fc83cb08f5c3163f95 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 21 Jul 2017 14:42:14 +0200 Subject: Rename twa to max_twa_parent, update docs --- docs/reference/index.html | 38 ++++---- docs/reference/max_twa_parent.html | 179 +++++++++++++++++++++++++++++++++++++ 2 files changed, 201 insertions(+), 16 deletions(-) create mode 100644 docs/reference/max_twa_parent.html (limited to 'docs/reference') diff --git a/docs/reference/index.html b/docs/reference/index.html index e995a75b..2d58eeeb 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -282,15 +282,9 @@ -

mkin_wide_to_long

- -

Convert a dataframe with observations over time into long format

- - - -

mkin_long_to_wide

+

geometric_mean

-

Convert a dataframe from long to wide format

+

Calculate the geometric mean

@@ -300,9 +294,9 @@ -

print

+

max_twa_parent

-

Print mkinmod objects

+

Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit

@@ -312,21 +306,33 @@ -

transform_odeparms backtransform_odeparms

+

mkin_wide_to_long

-

Functions to transform and backtransform kinetic parameters for fitting

+

Convert a dataframe with observations over time into long format

-

ilr invilr

+

mkin_long_to_wide

-

Function to perform isometric log-ratio transformation

+

Convert a dataframe from long to wide format

-

geometric_mean

+

print

-

Calculate the geometric mean

+

Print mkinmod objects

+ + + +

transform_odeparms backtransform_odeparms

+ +

Functions to transform and backtransform kinetic parameters for fitting

+ + + +

ilr invilr

+ +

Function to perform isometric log-ratio transformation

diff --git a/docs/reference/max_twa_parent.html b/docs/reference/max_twa_parent.html new file mode 100644 index 00000000..aeaf65ce --- /dev/null +++ b/docs/reference/max_twa_parent.html @@ -0,0 +1,179 @@ + + + + + + + + +Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit — max_twa_parent • mkin + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+

Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit

+
+ + +

This function calculates maximum moving window time weighted average concentrations +(TWAs) for kinetic models fitted with mkinfit. Currently, only +calculations for the parent are implemented for the SFO, FOMC and DFOP models, +using the analytical formulas given in the PEC soil section of the FOCUS +guidance.

+ + + 
max_twa_parent(fit, windows)
+ +

Arguments

+ + + + + + + + + + +
fit

An object of class mkinfit.

windows

The width of the time windows for which the TWAs should be calculated.

+ +

Value

+ +

A numeric vector, named using the windows argument.

+ +

References

+ +

FOCUS (2006) “Guidance Document on Estimating Persistence and + Degradation Kinetics from Environmental Fate Studies on Pesticides in EU + Registration” Report of the FOCUS Work Group on Degradation Kinetics, + EC Document Reference Sanco/10058/2005 version 2.0, 434 pp, + http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics

+ + +

Examples

+ 
  fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
+  max_twa_parent(fit, c(7, 21))
#>        7       21 
+#> 34.71343 18.22124
+
+ +
+ + +
+ + + -- cgit v1.2.1