Better documentation of PELMO_runs().

5 files changed, 26 insertions, 14 deletions

diff --git a/ChangeLog b/ChangeLog
index 38beb77..974436f 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,4 +1,10 @@
-commit 15c1b8c5ddadf938ce13d3dd9da2a09d8749f740
+commit eaf3b558747ff8228e87ded727a6c0e91a6579f8
+Author: Johannes Ranke <jranke@uni-bremen.de>
+Date:   2017-01-30 12:01:14 +0100
+
+    More extreme parameters for metabolites for testing
+
+commit a6c13f70f6c6669a8088827a602ac475fdf9b624
 Author: Johannes Ranke <jranke@uni-bremen.de>
 Date:   2017-01-29 16:58:53 +0100
 
diff --git a/DESCRIPTION b/DESCRIPTION
index 97b5962..e61f81a 100644
--- a/DESCRIPTION
+++ b/DESCRIPTION
@@ -2,7 +2,7 @@ Package: pfm
 Type: Package
 Title: Utilities for Pesticide Fate Modelling
 Version: 0.4-2
-Date: 2017-01-29
+Date: 2017-01-30
 Authors@R: person("Johannes Ranke", email = "jranke@uni-bremen.de", 
                   role = c("aut", "cre", "cph"))
 Description: Utilities for simple calculations of predicted environmental
diff --git a/R/PELMO_runs.R b/R/PELMO_runs.R
index 5d401ea..f708fa0 100644
--- a/R/PELMO_runs.R
+++ b/R/PELMO_runs.R
@@ -1,10 +1,12 @@
 #' Set up runs for FOCUS PELMO
 #'
-#' Per default, the runs are also executed with FOCUS PELMO, and the results are processed
-#' and returned. Currently, only FOCUS PELMO as installed on Linux (or other Unix systems)
+#' Per default, the runs are not only set up but also executed with FOCUS
+#' PELMO, the results are processed and returned. Currently, only FOCUS PELMO
+#' as installed on Linux (or other Unix systems)
 #' using the \code{\link{install_PELMO}} from the \code{PELMO.installeR} package
-#' maintained on github is supported. In such installations, FOCUS PELMO is installed into
-#' package installation directory of \code{PELMO.installeR} and run with \code{wine}.
+#' maintained on github is supported. In such installations, FOCUS PELMO is
+#' installed into the package installation directory of \code{PELMO.installeR}
+#' and run using \code{wine}.
 #'
 #' @param runs A list of lists. Each inner lists has an element named 'psm'
 #'   that holds the psm string, and elements named using three letter crop acronyms,
diff --git a/docs/reference/PELMO_runs.html b/docs/reference/PELMO_runs.html
index e872196..03b7b7b 100644
--- a/docs/reference/PELMO_runs.html
+++ b/docs/reference/PELMO_runs.html
@@ -70,11 +70,13 @@
     </div>
 
     
-    <p>Per default, the runs are also executed with FOCUS PELMO, and the results are processed
-and returned. Currently, only FOCUS PELMO as installed on Linux (or other Unix systems)
+    <p>Per default, the runs are not only set up but also executed with FOCUS
+PELMO, the results are processed and returned. Currently, only FOCUS PELMO
+as installed on Linux (or other Unix systems)
 using the <code>install_PELMO</code> from the <code>PELMO.installeR</code> package
-maintained on github is supported. In such installations, FOCUS PELMO is installed into
-package installation directory of <code>PELMO.installeR</code> and run with <code>wine</code>.</p>
+maintained on github is supported. In such installations, FOCUS PELMO is
+installed into the package installation directory of <code>PELMO.installeR</code>
+and run using <code>wine</code>.</p>
     
 
     <pre><span class='fu'>PELMO_runs</span>(<span class='no'>runs</span>, <span class='kw'>psm_dir</span> <span class='kw'>=</span> <span class='st'>"."</span>, <span class='kw'>version</span> <span class='kw'>=</span> <span class='st'>"5.5.3"</span>, <span class='kw'>PELMO_base</span> <span class='kw'>=</span> <span class='st'>"auto"</span>,
diff --git a/man/PELMO_runs.Rd b/man/PELMO_runs.Rd
index 1d81e6d..9967b0d 100644
--- a/man/PELMO_runs.Rd
+++ b/man/PELMO_runs.Rd
@@ -37,11 +37,13 @@ as used in \code{\link{FOCUS_GW_scenarios_2012}}.}
 \item{overwrite}{Should an existing run directories be overwritten}
 }
 \description{
-Per default, the runs are also executed with FOCUS PELMO, and the results are processed
-and returned. Currently, only FOCUS PELMO as installed on Linux (or other Unix systems)
+Per default, the runs are not only set up but also executed with FOCUS
+PELMO, the results are processed and returned. Currently, only FOCUS PELMO
+as installed on Linux (or other Unix systems)
 using the \code{\link{install_PELMO}} from the \code{PELMO.installeR} package
-maintained on github is supported. In such installations, FOCUS PELMO is installed into
-package installation directory of \code{PELMO.installeR} and run with \code{wine}.
+maintained on github is supported. In such installations, FOCUS PELMO is
+installed into the package installation directory of \code{PELMO.installeR}
+and run using \code{wine}.
 }
 \references{
 PELMO.installeR \url{https://jranke.github.io/PELMO.installeR}