This function retrieves the dimensional structure of indicators from the ARAD API, showing how indicators are organized and what dimensions are available.
Usage
arad_indicators_dims(
set_id = NULL,
indicator_id_list = NULL,
selection_id = NULL,
api_key = NULL,
base_url = "https://www.cnb.cz/aradb/api/v1",
encoding = "windows-1250"
)Arguments
- set_id
Character, set ID to get dimensions for a specific data set (required unless indicator_id_list or selection_id is provided)
- indicator_id_list
Character vector, specific indicator IDs to retrieve dimensions for (required unless set_id or selection_id is provided). Will be converted to comma-separated string.
- selection_id
Character, ID of a named selection created in ARAD user account (required unless set_id or indicator_id_list is provided)
- api_key
API key for ARAD access. If NULL, uses ARAD_API_KEY environment variable
- base_url
Base URL for the ARAD API
- encoding
Character encoding for the response (default "windows-1250")
Examples
if (FALSE) { # \dontrun{
# Get all indicator dimensions
dimensions <- arad_indicators_dims()
# Get dimensions for a specific data set
monetary_dims <- arad_indicators_dims(set_id = "MONETARY_SET")
# Get dimensions for specific indicators
specific_dims <- arad_indicators_dims(indicator_id_list = "SRUMD08402")
multiple_dims <- arad_indicators_dims(indicator_id_list = c("SRUMD08402", "SRUMD08403"))
# Get dimensions from a named selection
selection_dims <- arad_indicators_dims(selection_id = "my_selection")
} # }