toolGetMapping: Tool: GetMapping

In madrat: May All Data be Reproducible and Transparent (MADRaT) *

Tool: GetMapping

Description

Function which retrieves a mapping file

Usage

toolGetMapping(
  name,
  type = NULL,
  where = NULL,
  error.missing = TRUE,
  returnPathOnly = FALSE,
  activecalc = NULL
)

Arguments

name	File name of the mapping file. Supported file types are currently csv (, or ; separated), rds and rda (which needs to have the data stored with the object name "data"!). Use codetoolConvertMapping to convert between both formats
type	Mapping type (e.g. "regional", "cell", or "sectoral"). Can be set to NULL if file is not stored in a type specific subfolder
where	location to look for the mapping, either "mappingfolder", "local" (if the path is relative to your current directory) or the name of a package which contains the mapping. If set to NULL it will first try "local", then "mappingfolder" and afterwards scan all packages currently listed in getConfig("packages")
error.missing	Boolean which decides whether an error is returned if the mapping file does not exist or not.
returnPathOnly	If set to TRUE only the file path is returned
activecalc	If set, this argument helps to define the first package within which the mapping has to be sought for. This happens via finding in which package the active calc function is located.

Value

the mapping as a data frame

Author(s)

Jan Philipp Dietrich

See Also

calcOutput, toolConvertMapping

Examples

head(toolGetMapping("regionmappingH12.csv", where = "madrat"))

madrat documentation built on Aug. 23, 2023, 5:10 p.m.