toolGetMapping: Tool: GetMapping

Description Usage Arguments Value Author(s) See Also Examples

View source: R/toolGetMapping.R

Description

Function which retrieves a mapping file

Usage

1
2
3
4
5
6
7
toolGetMapping(
  name,
  type = NULL,
  where = "mappingfolder",
  error.missing = TRUE,
  returnPathOnly = FALSE
)

Arguments

name

File name of the mapping file. Supported file types are currently csv (, or ; separated) 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" or the name of a package which contains the mapping

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

Value

the mapping as a data frame

Author(s)

Jan Philipp Dietrich

See Also

calcOutput, toolConvertMapping

Examples

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

madrat documentation built on Dec. 25, 2019, 9:07 a.m.