get_structure: Extract 'nomis' Table Data for Chosen Dimension
In sgapi: Aid Querying 'nomis' and 'Office for National Statistics Open Geography' APIs
View source: R/get_structure.R
get_structure 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")
sgapi documentation built on June 8, 2025, 11:09 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
View source: R/get_structure.R
| get_structure | 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")
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.