Description of the Dataset

Source: R/00-datasets.R

This function provides a description of the important information about a dataset.

ons_desc(id = NULL)

Arguments

id

[character] Id that represents a dataset.

Value

A description of the requested dataset.

See also

ons_meta()

Examples

# \donttest{
ons_desc("cpih01")
#> Title: Consumer Prices Index including owner occupiers' housing costs (CPIH) 
#> ID: cpih01 
#> Keywords: Inflation 
#> -----------
#> Description: CPIH is the most comprehensive measure of inflation. It extends CPI to include a measure of the costs associated with owning, maintaining and living in one's own home, known as owner occupiers' housing costs (OOH), along with council tax. This dataset provides CPIH time series (2005 to latest published month), allowing users to customise their own selection, view or download. 
#> -----------
#> Release Frequency: Monthly 
#> State: published 
#> Next Release: 16 February 2022 
#> -----------
#> Latest Version: 18 
#> Edition(s): time-series 
# }