forked from pik-piam/madrat
-
Notifications
You must be signed in to change notification settings - Fork 0
/
retrieveData.Rd
81 lines (74 loc) · 2.94 KB
/
retrieveData.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/retrieveData.R
\name{retrieveData}
\alias{retrieveData}
\title{retrieveData}
\usage{
retrieveData(
model,
rev = 0,
dev = "",
cachetype = "def",
puc = identical(dev, ""),
strict = FALSE,
renv = TRUE,
...
)
}
\arguments{
\item{model}{The names of the model for which the data should be provided
(e.g. "magpie").}
\item{rev}{data revision which should be used/produced. Will be converted to
\code{\link[base]{numeric_version}}.}
\item{dev}{development suffix to distinguish development versions for the same data
revision. This can be useful to distinguish parallel lines of development.}
\item{cachetype}{defines what cache should be used. "rev" points to a cache
shared by all calculations for the given revision and sets forcecache to TRUE,
"def" points to the cache as defined in the current settings and does not change
forcecache setting.}
\item{puc}{Boolean deciding whether a fitting puc file (if existing) should be
read in and if a puc file (if not already existing) should be created.}
\item{strict}{Boolean which allows to trigger a strict mode. During strict mode
warnings will be taken more seriously and will cause 1. to have the number of
warnings as prefix of the created tgz file and 2. will prevent \code{retrieveData}
from creating a puc file.}
\item{renv}{Boolean which determines whether calculations should run
within a renv environment (recommended) or not (currently only applied in
\code{\link{pucAggregate}}). If activated, \code{renv} will check which packages
in which versions were used to create the puc file, download, install and
load these packages and run the aggregation with them. Otherwise, the packages
in the currently used environment are being used.}
\item{...}{(Optional) Settings that should be changed using \code{setConfig}
(e.g. regionmapping). or arguments which should be forwarded to the corresponding
fullXYZ function (Please make sure that argument names in full functions do not
match settings in \code{setConfig}!)}
}
\value{
Invisibly, the path to the newly created tgz archive.
}
\description{
Function to retrieve a predefined collection of calculations for a specific
regionmapping.
}
\note{
The underlying full-functions can optionally provide a list of information back to
\code{retrieveData}. Following list entries are currently supported:
\itemize{
\item \bold{tag} (optional) - additional name tag which will be included in the file
name of the aggregated collection (resulting tgz-file). This can be useful to highlight
information in the file name which otherwise would not be visible.
\item \bold{pucTag} (optional) - identical purpose as \bold{tag} but for the resulting
unaggregated collections (puc-files).
}
}
\examples{
\dontrun{
retrieveData("example", rev = "2.1.1", dev = "test", regionmapping = "regionmappingH12.csv")
}
}
\seealso{
\code{\link{calcOutput}},\code{\link{setConfig}}
}
\author{
Jan Philipp Dietrich, Lavinia Baumstark
}