get_structure {sgapi}R Documentation

Extract 'nomis' Table Data for Chosen Dimension

Description

Retrieve dataset for a valid 'nomis' table id and dimension. This extracts all of the available instances of the chosen dimension, which can then be used to filter the 'nomis' table.

Usage

get_structure(id, dim, base_url = "https://www.nomisweb.co.uk/api/v01")

Arguments

id

A valid 'nomis' id.

dim

The name of the g which dimension is queried.

base_url

Base nomis url to query

Value

An object with JSON structure for the chosen dimension of the selected 'nomis' table.

Examples

get_structure(id="NM_187_1",dim="industry")

[Package sgapi version 1.1.0 Index]