gen_val2var: Search for the Values of a Variable

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

Search for the Values of a Variable

Description

Function to extract the possible values from a variable from GENESIS. Values for continuous variables are not extractable, so the function returns a warning message.

Usage

gen_val2var(
  code = NULL,
  sortcriterion = c("code", "content"),
  error.ignore = FALSE,
  ...
)

Arguments

code	a string with a maximum length of 15 characters. Code from a GENESIS-Object. Only one code per iteration.
sortcriterion	a string. Indicator if the output should be sorted by 'code' or 'content'. This is a parameter of the GENESIS API call itself. The default is "code".
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. Always includes the code of the object, the title, and the type of the object. This is done to facilitate further processing of the data. Attributes are added to the dataframe describing the search configuration for the returned output.

Examples

## Not run: 
# Find the values of the variable "DLAND"
object <- gen_val2var(code = "DLAND")

## End(Not run)

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