cbs_get_meta: Get metadata of a cbs table

In cbsodataR: Statistics Netherlands (CBS) Open Data API Client

Get metadata of a cbs table

Description

Retrieve the meta data of a CBS open data table. Caching (cache=TRUE) improves the performance considerably.

Usage

cbs_get_meta(
  id,
  catalog = "CBS",
  verbose = FALSE,
  cache = TRUE,
  base_url = getOption("cbsodataR.base_url", BASE_URL)
)

Arguments

id	internal id of CBS table, can be retrieved with cbs_get_datasets()
catalog	catalog id, can be retrieved with cbs_get_datasets()
verbose	Print extra messages what is happening.
cache	should the result be cached?
base_url	optionally specify a different server. Useful for third party data services implementing the same protocol.

Details

The meta data of a CBS table is determined by the web api of Statistics Netherlands. cbsodataR stays close to this API. Each cbsodataR object has the following metadata items, which are all data.frames :

• ⁠$TableInfos⁠: data.frame with the descriptive publication metadata of the table, such as Title, Description, Summary etc.

• ⁠$DataProperties⁠: data.frame with the Title, Description, Unit etc. of each column in the dataset that is downloaded with cbs_get_data().

• ⁠$CategoryGroups⁠: hierarchical groupings of the code columns.

• ⁠$<code column>⁠: for each code column a data.frame with the Title, Key, Description etc. of each code / category in that column. e.g. Perioden for time codes c("2019JJ00","2018JJ00").

Value

cbs_table object containing several data.frames with meta data (see details)

See Also

Other meta data: cbs_add_date_column(), cbs_add_label_columns(), cbs_add_unit_column(), cbs_download_meta()

cbsodataR documentation built on Sept. 25, 2024, 5:07 p.m.