lm_ons_request_dataset: Make a POST request to the ONS API and return a filter output...

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

Description

lm_ons_request_dataset creates a POST request body based on the ONS API filter structure and sends the request a provided URI. A filter output ID is returned, which can be passed lm_ons_download_uri.

Usage

lm_ons_request_dataset(
  base_uri,
  dataset_id,
  dataset_edition,
  dataset_version,
  dataset_dimension = NULL,
  dataset_dimension_option = NULL
)

Arguments

base_uri	string. The base URI to connect to. ('filters?submitted=true' 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.
dataset_dimension_option	string. (Default: NULL). The option to use to filter by dimension. See lm_ons_dataset_dimension_options.

Value

string.

Examples

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

## End(Not run)

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