arad_catalog: Build an enriched catalogue of indicators within an ARAD...
In aradR: Modern R Client and Toolkit for the Czech National Bank ARAD API

arad_catalog

R Documentation

Build an enriched catalogue of indicators within an ARAD scope

Description

Combines basic indicator metadata with hierarchy paths and optional availability metadata for human-facing browsing. Exactly one normal ARAD selector must be supplied.

Usage

arad_catalog(
  indicator_ids = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  lang = c("cs", "en"),
  include_path = TRUE,
  include_availability = TRUE,
  api_key = NULL,
  base_url = NULL,
  encoding = "windows-1250",
  cache = NULL,
  cache_dir = NULL,
  cache_max_age = NULL
)

Arguments

`indicator_ids`	Character vector of indicator IDs.
`set_id`	ARAD set ID.
`base_id`	ARAD base ID.
`selection_id`	ARAD user selection ID.
`lang`	Metadata language, `"cs"` or `"en"`.
`include_path`	Include the ARAD hierarchy path for each indicator.
`include_availability`	Include earliest/latest availability boundaries, latest update timestamp and snapshot-context count. `data_to` is reported by ARAD and can extend into a forecast or reporting horizon; it is not necessarily the latest observed historical date.
`api_key`	ARAD API key. If `NULL`, `ARAD_API_KEY` is used.
`base_url`	ARAD API base URL. Primarily intended for testing.
`encoding`	Response encoding.
`cache`	Response cache mode: none, session, or disk.
`cache_dir`	Optional disk cache directory.
`cache_max_age`	Maximum cache age in seconds.