Package: sgapi 1.0.1
Andrew Christy
sgapi: Aid Querying 'nomis' and 'Office for National Statistics Open Geography' APIs
Facilitates extraction of geospatial data from the 'Office for National Statistics Open Geography' and 'nomis' Application Programming Interfaces (APIs). Simplifies process of querying 'nomis' datasets <https://www.nomisweb.co.uk/> and extracting desired datasets in dataframe format. Extracts area shapefiles at chosen resolution from 'Office for National Statistics Open Geography' <https://geoportal.statistics.gov.uk/>.
Authors:
sgapi_1.0.1.tar.gz
sgapi_1.0.1.zip(r-4.5)sgapi_1.0.1.zip(r-4.4)sgapi_1.0.1.zip(r-4.3)
sgapi_1.0.1.tgz(r-4.4-any)sgapi_1.0.1.tgz(r-4.3-any)
sgapi_1.0.1.tar.gz(r-4.5-noble)sgapi_1.0.1.tar.gz(r-4.4-noble)
sgapi_1.0.1.tgz(r-4.4-emscripten)sgapi_1.0.1.tgz(r-4.3-emscripten)
sgapi.pdf |sgapi.html✨
sgapi/json (API)
| # Install 'sgapi' in R: |
| install.packages('sgapi', repos = c('https://defra-data-science-centre-of-excellence.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/defra-data-science-centre-of-excellence/sgapi/issues
- availableBoundaries - List of available ONS boundaries
- lookup - Lookup to match Office for National Statistics (ONS) and 'nomis' boundary names
- nomisTables - #' List of tables on 'nomis'
- scalesForEachDataset - #' List of tables available at each ONS resolution
Last updated 6 months agofrom:a18f06d23a. Checks:OK: 7. Indexed: yes.
| Target | Result | Date |
|---|---|---|
| Doc / Vignettes | OK | Sep 13 2024 |
| R-4.5-win | OK | Sep 13 2024 |
| R-4.5-linux | OK | Sep 13 2024 |
| R-4.4-win | OK | Sep 13 2024 |
| R-4.4-mac | OK | Sep 13 2024 |
| R-4.3-win | OK | Sep 13 2024 |
| R-4.3-mac | OK | Sep 13 2024 |
Exports:assert_functionget_available_scalesget_boundariesget_boundaries_areanameget_keyword_table_idget_overviewget_structureget_tableget_table_dimensionsget_table_idget_table_info_briefget_table_link_lookuplist_boundarieslist_data_sourceslist_tables
Dependencies:askpassbitbit64classclassIntclicliprcpp11crayoncurlDBIdplyre1071fansigenericsgluehmshttrjsonliteKernSmoothlifecyclemagrittrMASSmimeopensslpillarpkgconfigprettyunitsprogressproxyR6Rcppreadrrlangs2sfsystibbletidyselecttzdbunitsutf8vctrsvroomwithrwkxml2
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Escape Function in Case of Errors | assert_function |
| List of available ONS boundaries | availableBoundaries availableBoundaries.rda |
| Available Boundary Scales for 'nomis' Table | get_available_scales |
| Get Boundaries Using Geospatial Filter | get_boundaries |
| Get Boundaries Using Area Names | get_boundaries_areaname |
| Keyword Search of 'nomis' | get_keyword_table_id |
| Table Overview | get_overview |
| Extract 'nomis' Table Data for Chosen Dimension | get_structure |
| Get 'nomis' Table | get_table |
| Table Dimensions | get_table_dimensions |
| Get 'nomis 'Table IDs | get_table_id |
| Key 'nomis' Table Information | get_table_info_brief |
| Lookup Between Boundary Scales | get_table_link_lookup |
| List Available Boundaries | list_boundaries |
| List 'nomis' Data Sources | list_data_sources |
| Available 'nomis' Tables | list_tables |
| Lookup to match Office for National Statistics (ONS) and 'nomis' boundary names | lookup lookup.rda |
| #' List of tables on 'nomis' | nomisTables nomisTables.rda |
| #' List of tables available at each ONS resolution | scalesForEachDataset scalesForEachDataset.rda |