cbs4_get_metadata: Retrieve the metadata of a publication

In statistiekcbs/cbsccb: Statistics Netherlands (CBS) Open Data API Client v4

Retrieve the metadata of a publication

Description

Retrieve the metadata of a publication. The meta object contains all metadata properties of cbsodata in the form of data.frames.

Usage

cbs4_get_metadata(
  id,
  catalog = "CBS",
  ...,
  base_url = getOption("cbsodata4.base_url", BASEURL4),
  verbose = getOption("cbsodata4.verbose", FALSE)
)

Arguments

id	Identifier of publication or data retrieved with cbs4_get_data()/cbs4_get_observations()
catalog	Catalog, from the set of cbs4_get_catalogs()
...	not used
base_url	alternative url that implements same interface as statistics netherlands.
verbose	Should the function report on retrieving the data

Details

Each data.frame describes properties of the CBS / Statistics Netherlands table: “Dimensions”, “MeasureCodes” and one ore more “\<Dimension\>Codes” describing the meta data of the borders of a CBS table.

Examples

if (interactive()){
  meta <- cbs4_get_metadata("80416ned")
  print(names(meta))

  # Dimension columns in the dataset
  meta$Dimensions

  # the metadata of the Measures/Topics
  meta$MeasureCodes

  # the metadata of the Perioden Categories
  meta$PeriodenCodes

  # all descriptive and publication meta data on this dataset
  meta$Properties
}

statistiekcbs/cbsccb documentation built on April 8, 2022, 2:38 a.m.