lm_ons_dataset_dimension_options: Return a list of options of a dimension of a dataset in the...

In thomascrines/labourmarketreports: Fetch data from APIs and generate markdown reports

Description

lm_ons_dataset_dimension_options returns a list of options of a dimension of a dataset available on the ONS API.

Usage

lm_ons_dataset_dimension_options(
  base_uri,
  dataset_id,
  dataset_edition,
  dataset_version,
  dataset_dimension
)

Arguments

base_uri	string. The base URI to connect to. ('datasets/' + dataset_id + '/editions/' + dataset_edition + '/versions/' + dataset_version + '/dimensions/' + dataset_dimension, '/options' is appended in the function).
dataset_id	string. An ID of an existing dataset in the ONS API. See lm_ons_datasets.
dataset_edition	string. An edition ID of an existing dataset in the ONS API. See lm_ons_dataset_editions.
dataset_version	string. A version ID of an existing dataset in the ONS API. See lm_ons_dataset_versions.
dataset_dimension	string. The name of an existing dimension in the specified dataset. See lm_ons_dataset_dimensions.

Value

string if one option available, list if multiple.

Examples

## Not run: 
lm_ons_dataset_dimension_options(base_uri = "https://api.beta.ons.gov.uk/v1/", dataset_id = "labour-market", dataset_edition = "time-series", dataset_version = "2", dataset_dimension = "agegroups")

## End(Not run)

thomascrines/labourmarketreports documentation built on Jan. 28, 2021, 9:47 a.m.