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 --- man/max_twa_parent.Rd | 40 ++++++++++++++++++++++++++++++++++++++++ man/twa.Rd | 40 ---------------------------------------- 2 files changed, 40 insertions(+), 40 deletions(-) create mode 100644 man/max_twa_parent.Rd delete mode 100644 man/twa.Rd (limited to 'man') diff --git a/man/max_twa_parent.Rd b/man/max_twa_parent.Rd new file mode 100644 index 00000000..b8c820bc --- /dev/null +++ b/man/max_twa_parent.Rd @@ -0,0 +1,40 @@ +\name{max_twa_parent} +\alias{max_twa_parent} +\title{ + Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit +} +\description{ +This function calculates maximum moving window time weighted average concentrations +(TWAs) for kinetic models fitted with \code{\link{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.} +\usage{ + max_twa_parent(fit, windows) +} +\arguments{ + \item{fit}{ + An object of class \code{\link{mkinfit}}. + } + \item{windows}{ + The width of the time windows for which the TWAs should be calculated. + } +} +\value{ + A numeric vector, named using the \code{windows} argument. +} +\examples{ + fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE) + max_twa_parent(fit, c(7, 21)) +} +\references{ + FOCUS (2006) \dQuote{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, + \url{http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics} +} +\author{ + Johannes Ranke +} +\keyword{ manip } diff --git a/man/twa.Rd b/man/twa.Rd deleted file mode 100644 index 815c97bd..00000000 --- a/man/twa.Rd +++ /dev/null @@ -1,40 +0,0 @@ -\name{twa} -\alias{twa} -\title{ - Function to calculate maximum time weighted average concentrations from kinetic models fitted with mkinfit -} -\description{ -This function calculates maximum moving window time weighted average concentrations -(TWAs) for kinetic models fitted with \code{\link{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.} -\usage{ - twa(fit, windows) -} -\arguments{ - \item{fit}{ - An object of class \code{\link{mkinfit}}. - } - \item{windows}{ - The width of the time windows for which the TWAs should be calculated. - } -} -\value{ - A numeric vector, named using the \code{windows} argument. -} -\examples{ - fit <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE) - twa(fit, c(7, 21)) -} -\references{ - FOCUS (2006) \dQuote{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, - \url{http://esdac.jrc.ec.europa.eu/projects/degradation-kinetics} -} -\author{ - Johannes Ranke -} -\keyword{ manip } -- cgit v1.2.1