summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohannes Ranke <johannes.ranke@jrwb.de>2026-02-06 17:39:23 +0100
committerJohannes Ranke <johannes.ranke@jrwb.de>2026-02-06 17:39:23 +0100
commit10146dc469b218a97319fc4d49f12cb73cc9b5ba (patch)
tree93d5c57e33446f81898e484b421e070c2a45a866 /man
parentf0bf040afbadf07c21dc65495e344c0d2a25f9c3 (diff)
Support units in UK drainage calculations
Also, address some R CMD check notes
Diffstat (limited to 'man')
-rw-r--r--man/PEC_sw_drainage_UK.Rd9
-rw-r--r--man/PEC_sw_exposit_runoff.Rd3
-rw-r--r--man/TOXSWA_cwa.Rd4
-rw-r--r--man/max_twa.Rd2
-rw-r--r--man/one_box.Rd4
5 files changed, 13 insertions, 9 deletions
diff --git a/man/PEC_sw_drainage_UK.Rd b/man/PEC_sw_drainage_UK.Rd
index 6125c3c..af020c6 100644
--- a/man/PEC_sw_drainage_UK.Rd
+++ b/man/PEC_sw_drainage_UK.Rd
@@ -15,15 +15,18 @@ PEC_sw_drainage_UK(
)
}
\arguments{
-\item{rate}{Application rate in g/ha}
+\item{rate}{Application rate in g/ha or with a compatible unit specified
+with the units package}
\item{interception}{The fraction of the application rate that does not reach the soil}
-\item{Koc}{The sorption coefficient normalised to organic carbon in L/kg}
+\item{Koc}{The sorption coefficient normalised to organic carbon in L/kg or a unit specified
+with the units package}
\item{latest_application}{Latest application date, formatted as e.g. "01 July"}
-\item{soil_DT50}{Soil degradation half-life, if SFO kinetics are to be used}
+\item{soil_DT50}{Soil degradation half-life, if SFO kinetics are to be used, in
+days or a time unit specified with the units package}
\item{model}{The soil degradation model to be used. Either one of "FOMC",
"DFOP", "HS", or "IORE", or an mkinmod object}
diff --git a/man/PEC_sw_exposit_runoff.Rd b/man/PEC_sw_exposit_runoff.Rd
index 393ed29..60c9b9f 100644
--- a/man/PEC_sw_exposit_runoff.Rd
+++ b/man/PEC_sw_exposit_runoff.Rd
@@ -21,7 +21,8 @@ PEC_sw_exposit_runoff(
)
}
\arguments{
-\item{rate}{The application rate in g/ha}
+\item{rate}{Application rate in g/ha or with a compatible unit specified
+with the units package}
\item{interception}{The fraction intercepted by the crop}
diff --git a/man/TOXSWA_cwa.Rd b/man/TOXSWA_cwa.Rd
index 0923f10..126fed4 100644
--- a/man/TOXSWA_cwa.Rd
+++ b/man/TOXSWA_cwa.Rd
@@ -4,14 +4,14 @@
\alias{TOXSWA_cwa}
\title{R6 class for holding TOXSWA water concentration data and associated statistics}
\format{
-An \code{\link{R6Class}} generator object.
+An \link[R6:R6Class]{R6::R6Class} generator object.
}
\description{
An R6 class for holding TOXSWA water concentration (cwa) data
and some associated statistics. like maximum moving window average
concentrations, and dataframes holding the events exceeding specified
thresholds. Usually, an instance of this class will be generated
-by \code{\link{read.TOXSWA_cwa}}.
+by \link{read.TOXSWA_cwa}.
}
\examples{
H_sw_R1_stream <- read.TOXSWA_cwa("00003s_pa.cwa",
diff --git a/man/max_twa.Rd b/man/max_twa.Rd
index 43ad50e..0fb5c93 100644
--- a/man/max_twa.Rd
+++ b/man/max_twa.Rd
@@ -19,7 +19,7 @@ for finding the maximum. It is therefore recommended to check this using
\code{max_twa}.
}
\details{
-The method working directly on fitted \code{\link{mkinfit}} objects uses the
+The method working directly on fitted \link[mkin:mkinfit]{mkin::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
}
diff --git a/man/one_box.Rd b/man/one_box.Rd
index a60aa39..afa6e10 100644
--- a/man/one_box.Rd
+++ b/man/one_box.Rd
@@ -19,10 +19,10 @@ one_box(x, ini, ..., t_end = 100, res = 0.01)
\item{x}{When numeric, this is the half-life to be used for an exponential
decline. When a character string specifying a parent decline model is given
e.g. \code{FOMC}, \code{parms} must contain the corresponding parameters.
-If x is an \code{\link{mkinfit}} object, the decline is calculated from this
+If x is an \link[mkin:mkinfit]{mkin::mkinfit} object, the decline is calculated from this
object.}
-\item{ini}{The initial amount. If x is an \code{\link{mkinfit}} object, and
+\item{ini}{The initial amount. If x is an \link[mkin:mkinfit]{mkin::mkinfit} object, and
ini is 'model', the fitted initial concentrations are used. Otherwise, ini
must be numeric. If it has length one, it is used for the parent and
initial values of metabolites are zero, otherwise, it must give values for

Contact - Imprint