get_overview: Table Overview
In sgapi: Aid Querying 'nomis' and 'Office for National Statistics Open Geography' APIs
get_overview R Documentation
Table Overview
Description
Retrieve dataset overview for a valid 'nomis' table id.
Returned object includes description of the dataset, last update date, contact for the data.
It also extracts all of the available instances of the available table dimensions, which can then be used to filter the dataset 'nomis' table.
Usage
get_overview(id, base_url = "https://www.nomisweb.co.uk/api/v01")
Arguments
id
A valid 'nomis' id.
base_url
Base nomis url to query
Value
An object with overview information of chosen data set. Object has the structure of the extracted JSON object.
Examples
get_overview(id="NM_1_1")
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.
| get_overview | R Documentation |
Table Overview
Description
Retrieve dataset overview for a valid 'nomis' table id. Returned object includes description of the dataset, last update date, contact for the data. It also extracts all of the available instances of the available table dimensions, which can then be used to filter the dataset 'nomis' table.
Usage
get_overview(id, base_url = "https://www.nomisweb.co.uk/api/v01")
Arguments
id |
A valid 'nomis' id. |
base_url |
Base nomis url to query |
Value
An object with overview information of chosen data set. Object has the structure of the extracted JSON object.
Examples
get_overview(id="NM_1_1")
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.