ons_codelists: Explore codes and lists

In onsr: Client for the 'ONS' API

Explore codes and lists

Description

Used to get details about codes and code lists stored by ONS. Codes are used to provide a common definition when presenting statistics with related categories. Codes are gathered in code lists, which may change over time to include new or different codes. The meaning of a code should not change over time, but new codes may be created where new meaning is required.

Usage

ons_codelists()

ons_codelist(code_id = NULL)

ons_codelist_editions(code_id = NULL)

ons_codelist_edition(code_id = NULL, edition = NULL)

Arguments

code_id	⁠[character]⁠. The id of a codelist.
edition	⁠[character]⁠ A subset of the dataset representing a specific time period. For some datasets this edition can contain all time periods (all historical data). The latest version of this is displayed by default.

Value

A list or character vector.

Examples

ons_codelists()
ons_codelist(code_id = "quarter")

#editions
ons_codelist_editions(code_id = "quarter")
ons_codelist_edition(code_id = "quarter", edition = "one-off")

onsr documentation built on May 29, 2024, 2:50 a.m.