aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorJohannes Ranke <jranke@uni-bremen.de>2017-01-30 16:10:30 +0100
committerJohannes Ranke <jranke@uni-bremen.de>2017-01-30 16:10:30 +0100
commite6bb9654679f43af6958d6e28cb5206abb91d574 (patch)
tree1d2532c3a00b1c81838b555c1ee567cbb4547ac8 /man
parentf6e76c9a71fc99594a0fc7e0b21b77b396117b99 (diff)
Test reproducing the FOCUS Summary information
generated from the FOCUS PELMO GUI, as copied into the text files in the testdata directory.
Diffstat (limited to 'man')
-rw-r--r--man/PELMO_path.Rd2
-rw-r--r--man/PELMO_runs.Rd9
2 files changed, 10 insertions, 1 deletions
diff --git a/man/PELMO_path.Rd b/man/PELMO_path.Rd
index e8ca50e..49292c2 100644
--- a/man/PELMO_path.Rd
+++ b/man/PELMO_path.Rd
@@ -4,7 +4,7 @@
\alias{PELMO_path}
\title{Create a path of run directories as the PELMO GUI does}
\usage{
-PELMO_path(psm, crop, scenario)
+PELMO_path(psm, crop, scenario = NA)
}
\arguments{
\item{psm}{The psm identifier}
diff --git a/man/PELMO_runs.Rd b/man/PELMO_runs.Rd
index 9967b0d..60519bd 100644
--- a/man/PELMO_runs.Rd
+++ b/man/PELMO_runs.Rd
@@ -36,6 +36,10 @@ 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
+ PEC data.
+}
\description{
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
@@ -45,6 +49,11 @@ 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}.
}
+\details{
+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.
+}
\references{
PELMO.installeR \url{https://jranke.github.io/PELMO.installeR}

Contact - Imprint