gen_metadata: Search for Meta-Information for All Types of Objects

In restatis: Web API Client for the German Federal Statistical Office Database

Search for Meta-Information for All Types of Objects

Description

Function to search for meta-information for all types of objects.

Usage

gen_metadata(
  code = NULL,
  category = c("Cube", "Statistic", "Table", "Variable", "Value"),
  error.ignore = FALSE,
  ...
)

Arguments

code	string with a maximum length of 15 characters. Code from a GENESIS-Object. Only one code per iteration.
category	a string. Specific object-types: 'Cube', 'Statistic', "Table", "Variable" and 'Value'. The function needs a specified object type.
error.ignore	a logical. Indicator if the function should stop if an error occurs or no object for the request is found or if it should produce a token as response.
...	Additional parameter of the GENESIS API call. These parameters are only affecting the GENESIS API call itself, no further processing.

Value

A list with all recalled elements from GENESIS. Attributes are added to the dataframe describing the search configuration for the returned output.

Examples

## Not run: 
# Find meta-information of the table with the code "11111"
object <- gen_metadata(code = "11111", category = "Table")

## End(Not run)

restatis documentation built on July 9, 2023, 5:31 p.m.