statsDK (version 0.1.1)

retrieve_metadata: Retrieves metadata for a specific table from Statistics Denmark

Description

The function retrieves a list with a lot of metadata about a certain table.

Usage

retrieve_metadata(table_id, base_url = "http://api.statbank.dk/v1/")

Arguments

table_id

is the id of the table you want to call. You can get table ids by calling the retrieve_tables function.

base_url

is the base url for the API you wish to call. Statistics Denmark can sometimes create custom API's that you can use by changing this parameter.

Value

a list

Details

id

The id of the table.

text

A description of what the data in the table is about.

unit

What unit the data is in.

contact

Who to contact regarding the data.

documentation

Link to a web page with detailed description of the data.

footnote

A footnote if applicable.

variables

Details about the variables in the table. Is very useful for when using the retrieve_data function.

Examples

# NOT RUN {
metadata <- statsDK::retrieve_metadata("PRIS111")
dplyr::glimpse(metadata)
# }