aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-01-19 10:36:19 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2017-01-19 10:36:19 +0100
commitdd30f0d0ff1d8d0cc46aaef6e0917c51fe798f52 (patch)
treea954197c4e8e093d4b08c08eab14753b58602ff4 /man
parent3ead7acba845b4f2552f555dfb29da889ed0cda8 (diff)
Move mkin::twa to pfm::max_twa.mkinfit
- Add max_twa.mkinfit() recently introduced to mkin as mkin::twa() but never released with it - Add a test to check max_twa.one_box() against analytical solutions in max_twa.mkinfit(). - Clean up R CMD check - Update docs
Diffstat (limited to 'man')
-rw-r--r--man/max_twa.Rd19
-rw-r--r--man/one_box.Rd12
2 files changed, 27 insertions, 4 deletions
diff --git a/man/max_twa.Rd b/man/max_twa.Rd
index e39165a..0a8dcca 100644
--- a/man/max_twa.Rd
+++ b/man/max_twa.Rd
@@ -18,6 +18,25 @@ for finding the maximum. It is therefore recommended to check this using
\code{\link{plot.one_box}} using the window size for the argument
\code{max_twa}.
}
+\details{
+The method working directly on fitted \code{\link{mkinfit}} objects uses the
+equations given in the PEC soil section of the FOCUS guidance and is restricted
+SFO, FOMC and DFOP models and to the parent compound
+}
+\examples{
+pred <- sawtooth(one_box(10),
+ applications = data.frame(time = c(0, 7), amount = c(1, 1)))
+max_twa(pred)
+pred_FOMC <- mkinfit("FOMC", FOCUS_2006_C, quiet = TRUE)
+max_twa(pred_FOMC)
+}
+\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}
+}
\seealso{
\code{\link{twa}}
}
diff --git a/man/one_box.Rd b/man/one_box.Rd
index 5a46142..8132a70 100644
--- a/man/one_box.Rd
+++ b/man/one_box.Rd
@@ -7,18 +7,22 @@
\alias{one_box.mkinfit}
\title{Create a time series of decline data}
\usage{
-one_box(x, ..., t_end = 100, res = 0.01)
+one_box(x, ini, ..., t_end = 100, res = 0.01)
-\method{one_box}{numeric}(x, ..., t_end = 100, res = 0.01)
+\method{one_box}{numeric}(x, ini = 1, ..., t_end = 100, res = 0.01)
-\method{one_box}{character}(x, parms, ..., t_end = 100, res = 0.01)
+\method{one_box}{character}(x, ini = 1, parms, ..., t_end = 100,
+ res = 0.01)
-\method{one_box}{mkinfit}(x, ..., t_end = 100, res = 0.01)
+\method{one_box}{mkinfit}(x, ini = c("model", 1), ..., t_end = 100,
+ res = 0.01)
}
\arguments{
\item{x}{When numeric, this is the half-life to be used for an exponential
decline. If x is an mkinfit object, the decline is calculated from this object}
+\item{ini}{The initial amount for each compound}
+
\item{...}{Further arguments passed to methods}
\item{t_end}{End of the time series}

Contact - Imprint