lm_nomis_download_dataset: Download a dataset from the NOMIS API

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

Description

lm_nomis_download_dataset downloads a CSV file from the NOMIS API.

Usage

lm_nomis_download_dataset(
  base_uri,
  dataset_id,
  filter_string = NULL,
  row_limit = NULL
)

Arguments

base_uri	string. The base URI of the API.
dataset_id	string. An ID of an existing dataset in the NOMIS API. See lm_nomis_datasets.
filter_string	string. An optional string describing filter options and dimensions.
row_limit	string. An optional number of rows to return.

Value

list.

Examples

## Not run: 
lm_nomis_download_dataset(base_uri = "https://api.beta.ons.gov.uk/v1/", dataset_id = "NM_1_1")
lm_nomis_download_dataset(base_uri = "https://api.beta.ons.gov.uk/v1/", dataset_id = "NM_1_1", filter_string = "?geography=2092957697")
lm_nomis_download_dataset(base_uri = "https://api.beta.ons.gov.uk/v1/", dataset_id = "NM_1_1", row_limit = "5")
lm_nomis_download_dataset(base_uri = "https://api.beta.ons.gov.uk/v1/", dataset_id = "NM_1_1", filter_string = "?geography=2092957697", row_limit = "5")

## End(Not run)

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