Skip to contents

Fetch Czech National Bank (CNB) ARAD dimensions

Source: R/cnb.R
cnb_dimension.Rd

Retrieve the dimension structure of indicators from the CNB ARAD database, returning one row per indicator dimension.

Usage

cnb_dimension(
  indicator_id = NULL,
  set_id = NULL,
  base_id = NULL,
  selection_id = NULL,
  lang = "en",
  api_key = cnb_arad_key()
)

Source

https://www.cnb.cz/docs/arad20/dokumentace/arad_rest_api_cs.pdf

Arguments

indicator_id

(NULL | character())
One or more indicator identifiers to retrieve (e.g. "SMV5M603"). Exactly one of indicator_id, set_id, base_id, or selection_id must be provided.

set_id

(NULL | character(1))
A set ("sestava") identifier, returning all of its indicators.

base_id

(NULL | character(1))
A base identifier, returning all of its indicators.

selection_id

(NULL | character(1))
The identifier of a named selection ("My selections") created in your ARAD account.

lang

(character(1))
Language for the textual attributes, either "en" or "cs". Default "en".

api_key

(character(1))
API key to use for the request. Defaults to the value returned by cnb_arad_key(), which reads from the CNB_ARAD_KEY environment variable.

Value

A data.table::data.table() with columns including indicator_id, base_code, base_name, dim_code, dim_name, dim_value_code, dim_value_name, and dim_rank.

See also

Other metadata: bbk_dimension(), bbk_metadata(), bdf_dimension(), bdp_dataset(), bdp_dimension(), bdp_domain(), bdp_series(), bis_dimension(), bis_metadata(), boj_metadata(), cnb_indicators(), cnb_snapshots(), cnb_tree(), ecb_dimension(), ecb_metadata(), nob_dimension(), nob_metadata(), onb_dimension(), onb_frequency(), onb_hierarchy(), onb_metadata(), onb_toc(), snb_dimension(), snb_metadata(), snb_toc(), srb_calendar(), srb_series()

Examples

if (FALSE) { # \dontrun{
cnb_dimension(indicator_id = "MIRFMDF12ERATPECD")
} # }