metadata_: Get metadata

In long39ng/restatis: RESTful API Wrapper to Access Data from the Federal Statistical Office of Germany (Destatis)

Description

Retrieves metadata for a statistic, table, variable or value

Usage

metadata_statistic(
  name,
  area = c("free", "user", "all"),
  language = getOption("genesis_language"),
  genesis = getOption("genesis")
)

metadata_table(
  name,
  area = c("free", "user", "all"),
  language = getOption("genesis_language"),
  genesis = getOption("genesis")
)

metadata_value(
  name,
  area = c("free", "user", "all"),
  language = getOption("genesis_language"),
  genesis = getOption("genesis")
)

metadata_variable(
  name,
  area = c("free", "user", "all"),
  language = getOption("genesis_language"),
  genesis = getOption("genesis")
)

Arguments

name	Code of the variable (e.g. retrieved using catalogue_variables)
area	Area in which the object is stored: "free" = objects in the public catalogue "user" = objects saved to "Meine Tabellen"
language	Search terms, returned messages and data descriptions in German ("de") or English ("en")? A default value can also be set to the global option genesis_language via options(), e.g. options(genesis_language = "de").
genesis	Which GENESIS database should be used? One of: "destatis", "regionalstatistik", "bildungsmonitoring", "bayern", "nrw", "sachsen-anhalt". A default value can also be set to the global option genesis via options(), e.g. options(genesis = "destatis"), so that genesis does not have to be specified in the function call.

Examples

## Not run: 
options(genesis = "destatis")
metadata_statistic("12411")
metadata_table("12411-0001")
metadata_variable("KREISE")
metadata_value("VV101")

## End(Not run)

long39ng/restatis documentation built on Feb. 5, 2022, 6:26 p.m.