Correct psm file in the example with metabolites

1 files changed, 26 insertions, 1 deletions

diff --git a/man/PELMO_runs.Rd b/man/PELMO_runs.Rd
index 60519bd..ce5c7af 100644
--- a/man/PELMO_runs.Rd
+++ b/man/PELMO_runs.Rd
@@ -37,7 +37,7 @@ as used in \code{\link{FOCUS_GW_scenarios_2012}}.}
 \item{overwrite}{Should an existing run directories be overwritten}
 }
 \value{
-If evaluate is TRUE, a list of lists of data frames holding the
+If evaluate is TRUE, a list of lists of matrices holding the
   PEC data.
 }
 \description{
@@ -54,8 +54,33 @@ As a side effect, an R data file (period_pfm.rda) is generated in each
 run directory, holding the results for all FOCUS periods, equivalent to
 the period.plm file generated by the FOCUS PELMO GUI.
 }
+\examples{
+# Reproduce the official test results for annual application of Pesticide D
+# to winter cereals at the day before emergence
+runs_1 <- list(
+  list(psm = 'Pesticide_D',
+       win = c("Cha", "Ham", "Jok", "Kre", "Oke", "Pia", "Por", "Sev", "Thi")),
+  list(psm = 'Pesticide_D_1_day_pre_em_every_third_year',
+       pot = c("Cha", "Ham", "Jok", "Kre", "Oke", "Pia", "Por", "Sev", "Thi")))
+time_1 <- system.time(
+  PECgw_1 <- PELMO_runs(runs_1, psm_dir = system.file("testdata", package = "pfm"),
+    cores = 6, overwrite = TRUE)
+)
+print(PECgw_1)
+# We get exactly the same PECgw values (on Linux, calling PELMO using Wine).
+print(time_1)
+
+# Demonstrate some results with metabolites.
+runs_2 <- list(list(psm = 'Pesticide_D_1_May_every_other_year_mets',
+                    win = c("Cha", "Ham", "Kre")))
+PECgw_2 <- PELMO_runs(runs_2, psm_dir = system.file("testdata", package = "pfm"),
+  cores = 3, overwrite = TRUE)
+print(PECgw_2)
+}
 \references{
 PELMO.installeR \url{https://jranke.github.io/PELMO.installeR}
 
 Wine \url{https://winehq.org}
+
+PELMO test results \url{http://esdac.jrc.ec.europa.eu/public_path/projects_data/focus/gw/models/pelmo/test-results/test_results_FOCUS_PELMO_5_5_3.doc}
 }