Additional Parameters for API Calls with {restatis}

Parameter: Selection & Searchcriterion

The selection parameter is a string that specifies the filter to use for filtering the API call. The criterion to which this parameter is applied to is defined by the searchcriterion parameter. The maximum length of the string depends on the function being used, but often times varies between 10 and 15 characters. It is possible to use ‘*’ as a placeholder. The default for this parameter is no filtering.

The searchcriterion parameter is a string that specifies the criterion to be used by the selection parameter. Possible values depend on the function being used, but are often times “code” for filtering based on code or “content” for filtering based on the content description. The default for this parameter is no filter criterion. Often times, the searchcriterion parameter and the sortcriterion parameter have the same possible values.

Examples:

# Get the values of the variable "WAM8" which code starts with "WA29"
gen_val2var("WAM8", selection = "WA29*", searchcriterion = "code", database = "genesis")

# The same result can be achieved by the following line due to the default of the "searchcriterion" parameter:
gen_val2var("WAM8", selection = "WA29*", database = "genesis")

Parameter: Sortcriterion

The sortcriterion parameter is a string that specifies whether the raw output of the API call is sorted according to the specified input. Possible values depend on the function being used, but often times “code” for sorting based on code and “content” for sorting based on the content description are possible. The default is no sorting.

Examples:

# Get the values of the variable "WAM8" sorted based on their codes
gen_val2var("WAM8", sortcriterion = "code")

Parameter: Pagelength

The pagelength parameter is a number between 1 and 2500. It indicates the maximum length of the API call output. Default is 100.

Examples:

# Get the values of the variable "WAM8", where the maximum length of the output is 2500 entries
gen_val2var("WAM8", pagelength = 2500)

Parameter: Language

The language parameter is a string. It indicates if the API call output is in German by using “de” or in English by using “en”. Default is “en” (API default is “de” but it is overwritten by {restatis} to being “en”).

Examples:

# Get the values of the variable "WAM8" in German
gen_val2var("WAM8", language = "de")

# Get the values of the variable "WAM8" in English
gen_val2var("WAM8", language = "en")