Improve docs, fail with erroneus crop_group arguments

PEC_sw_drift: The argument 'crop_group_focus' was renamed
to 'crop_group_RF' to make it easier to understand the
relation to the 'drift_data' argument.

3 files changed, 19 insertions, 19 deletions

diff --git a/man/PEC_sw_drift.Rd b/man/PEC_sw_drift.Rd
index c576753..a24b783 100644
--- a/man/PEC_sw_drift.Rd
+++ b/man/PEC_sw_drift.Rd
@@ -12,7 +12,7 @@ PEC_sw_drift(
   drift_data = c("JKI", "RF"),
   crop_group_JKI = c("Ackerbau", "Obstbau frueh", "Obstbau spaet", "Weinbau frueh",
     "Weinbau spaet", "Hopfenbau", "Flaechenkulturen > 900 l/ha", "Gleisanlagen"),
-  crop_group_focus = c("arable", "hops", "vines, late", "vines, early", "fruit, late",
+  crop_group_RF = c("arable", "hops", "vines, late", "vines, early", "fruit, late",
     "fruit, early", "aerial"),
   distances = c(1, 5, 10, 20),
   formula = c("Rautmann", "FOCUS"),
@@ -38,9 +38,9 @@ either in the original form or integrated over the width of the water body, depe
 on the 'formula' argument.}
 
 \item{crop_group_JKI}{When using the 'JKI' drift data, one of the German names
-as used in \link{drift_parameters_focus}.}
+as used in \link{drift_parameters_focus}. Will only be used if drift_data is 'JKI'.}
 
-\item{crop_group_focus}{One of the crop groups as used in \link{drift_parameters_focus}}
+\item{crop_group_RF}{One of the crop groups as used in \link{drift_parameters_focus}}
 
 \item{distances}{The distances in m for which to get PEC values}
 
@@ -75,13 +75,13 @@ PEC_sw_drift(100, drift_data = "RF")
 PEC_sw_drift(100, distances = c(1, 3, 5, 6, 10, 20, 50, 100), drift_data = "RF")
 
 # or consider aerial application
-PEC_sw_drift(100, distances = c(1, 3, 5, 6, 10, 20, 50, 100), drift_data = "RF", 
-  crop_group_focus = "aerial")
+PEC_sw_drift(100, distances = c(1, 3, 5, 6, 10, 20, 50, 100), drift_data = "RF",
+  crop_group_RF = "aerial")
 
 # Using custom drift percentages is also supported
 PEC_sw_drift(100, drift_percentages = c(2.77, 0.95, 0.57, 0.48, 0.29, 0.15, 0.06, 0.03))
 
-# The influence of assuming a 45° angle of the sides of the waterbody and the width of the 
+# The influence of assuming a 45° angle of the sides of the waterbody and the width of the
 # waterbody can be illustrated
 PEC_sw_drift(100)
 PEC_sw_drift(100, drift_data = "RF")
diff --git a/man/PEC_sw_exposit_drainage.Rd b/man/PEC_sw_exposit_drainage.Rd
index c809e08..b145d5c 100644
--- a/man/PEC_sw_exposit_drainage.Rd
+++ b/man/PEC_sw_exposit_drainage.Rd
@@ -44,10 +44,10 @@ autumn/winter/early spring.}
 \value{
 A list containing the following components
 \describe{
-\item{perc_runoff}{The runoff percentages for dissolved and bound substance}
-\item{runoff}{A matrix containing dissolved and bound input for the different distances}
-\item{PEC_sw_runoff}{A matrix containing PEC values for dissolved and bound substance
-for the different distances. If the rate was given in g/ha, the PECsw are in microg/L.}
+\item{perc_drainage_total}{Gesamtaustrag (total fraction of the residue drained)}
+\item{perc_peak}{Stoßbelastung (fraction drained at event)}
+\item{PEC_sw_drainage}{A matrix containing PEC values for the spring and autumn
+scenarios. If the rate was given in g/ha, the PECsw are in microg/L.}
 }
 }
 \description{
diff --git a/man/drift_percentages_rautmann.Rd b/man/drift_percentages_rautmann.Rd
index 5fb2586..e2a50d1 100644
--- a/man/drift_percentages_rautmann.Rd
+++ b/man/drift_percentages_rautmann.Rd
@@ -7,7 +7,7 @@
 drift_percentages_rautmann(
   distances,
   applications = 1,
-  crop_group_focus = c("arable", "hops", "vines, late", "vines, early", "fruit, late",
+  crop_group_RF = c("arable", "hops", "vines, late", "vines, early", "fruit, late",
     "fruit, early", "aerial"),
   formula = c("Rautmann", "FOCUS"),
   widths = 1
@@ -18,7 +18,7 @@ drift_percentages_rautmann(
 
 \item{applications}{Number of applications for selection of drift percentile}
 
-\item{crop_group_focus}{One of the crop groups as used in \link{drift_parameters_focus}}
+\item{crop_group_RF}{One of the crop groups as used in \link{drift_parameters_focus}}
 
 \item{formula}{By default, the original Rautmann formula is used. If you
 specify "FOCUS", mean drift input over the width of the water body is
@@ -30,7 +30,7 @@ calculated as described in Chapter 5.4.5 of the FOCUS surface water guidance}
 Calculate drift percentages based on Rautmann data
 }
 \examples{
-# Compare JKI data with Rautmann formula
+# Compare JKI data with Rautmann and FOCUS formulas for arable crops (default)
 # One application on field crops, for 1 m, 3 m and 5 m distance
 drift_data_JKI[[1]][as.character(c(1, 3, 5)), "Ackerbau"]
 drift_percentages_rautmann(c(1, 3, 5))
@@ -38,20 +38,20 @@ drift_percentages_rautmann(c(1, 3, 5), formula = "FOCUS")
 
 # One application to early or late fruit crops
 drift_data_JKI[[1]][as.character(c(3, 5, 20, 50)), "Obstbau frueh"]
-drift_percentages_rautmann(c(3, 5, 20, 50), crop_group = "fruit, early")
-drift_percentages_rautmann(c(3, 5, 20, 50), crop_group = "fruit, early",
+drift_percentages_rautmann(c(3, 5, 20, 50), crop_group_RF = "fruit, early")
+drift_percentages_rautmann(c(3, 5, 20, 50), crop_group_RF = "fruit, early",
   formula = "FOCUS")
 drift_data_JKI[[1]][as.character(c(3, 5, 20, 50)), "Obstbau spaet"]
-drift_percentages_rautmann(c(3, 5, 20, 50), crop_group = "fruit, late")
-drift_percentages_rautmann(c(3, 5, 20, 50), crop_group = "fruit, late",
+drift_percentages_rautmann(c(3, 5, 20, 50), crop_group_RF = "fruit, late")
+drift_percentages_rautmann(c(3, 5, 20, 50), crop_group_RF = "fruit, late",
   formula = "FOCUS")
 
 # We get a continuum if the waterbody covers the hinge distance
 # (11.4 m for 1 early app to fruit)
 x <- seq(3, 30, by = 0.1)
-d <- drift_percentages_rautmann(x, crop_group = "fruit, early", formula = "FOCUS")
+d <- drift_percentages_rautmann(x, crop_group_RF = "fruit, early", formula = "FOCUS")
 plot(x, d, type = "l",
-  xlab = "Distance of near edge [m]", 
+  xlab = "Distance of near edge [m]",
   ylab = "Mean drift percentage over waterbody width",
   main = "One application to fruit, early")
 abline(v = 11.4, lty = 2)