cso_get_meta: Returns a data frame with the metadata of a CSO data table

View source: R/cso_get_meta.R

cso_get_metaR Documentation

Returns a data frame with the metadata of a CSO data table

Description

Checks the CSO PxStat API for a metadata on a dataset and returns it as a list of metadata and contained statistics.

Usage

cso_get_meta(table_code, cache = TRUE, flush_cache = TRUE)

Arguments

table_code

string. A valid code for a table on data.cso.ie .

cache

logical. Whether to use cached data, if available. Default value is TRUE.

flush_cache

logical. If TRUE (default) the cache will be checked for old, unused files. Any files which have not been accessed in the last month will be deleted

Value

list with eight elements:

  • The title of the table.

  • The units used (the R class of the value column)

  • The Copyright on the data.

  • The time interval used in the data. (Census year, Quarter, Month)

  • The date the table was last modified.

  • The names of the variables included in the table, returned as a character vector with one element for each variable.

  • The names of the statistics included in the table, returned as a character vector with one element for each statistic.

  • An indicator if the statistics are experimental

Examples

meta1 <- cso_get_meta("HS014", cache = FALSE)


csodata documentation built on June 10, 2022, 5:09 p.m.