diff --git a/pkgdown.yml b/pkgdown.yml index 93f2f38..0bc0e2e 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.9 pkgdown_sha: ~ articles: ukgeographies: ukgeographies.html -last_built: 2024-06-30T21:10Z +last_built: 2024-06-30T22:13Z urls: reference: https://warwickcim.github.io/ukgeographies/reference article: https://warwickcim.github.io/ukgeographies/articles diff --git a/reference/boundaries_get.html b/reference/boundaries_get.html index 5681483..d05f717 100644 --- a/reference/boundaries_get.html +++ b/reference/boundaries_get.html @@ -54,7 +54,7 @@

Usage

- 
boundaries_get(boundary, year, detail_level = "BUC")
+ 
boundaries_get(boundary, year = NULL, detail_level = "BUC")
diff --git a/reference/index.html b/reference/index.html index 68c325a..4d14b17 100644 --- a/reference/index.html +++ b/reference/index.html @@ -59,6 +59,11 @@

All functionsboundaries_get()
Retrieve Geographical Boundaries
+
+ + ons_boundaries +
+
ONS Boundaries

diff --git a/reference/ons_boundaries.html b/reference/ons_boundaries.html new file mode 100644 index 0000000..c6a12a3 --- /dev/null +++ b/reference/ons_boundaries.html @@ -0,0 +1,123 @@ + +ONS Boundaries — ons_boundaries • ukgeographies + Skip to contents + + +
+
+
+

ONS Boundaries

+ Source: R/data.R +
ons_boundaries.Rd
+
+ +
+

Metadata about a subset of the geographical boundaries from ONS' geoportal that can be downloaded by +{ukgeographies}. +These boundaries have been retrieved from the services provided by +ONS' geoportal API and +automatically categorised from their URLS, to +match Geoportal's menus and datasets.

+
+ +
+

Usage

+ 
ons_boundaries
+
+ +
+

Format

+

A data frame with 513 rows and 7 +columns:

id
+

A unique identifier for every boundary

+ +
service
+

URL pointing to the API service

+ +
boundary_type
+

Type of boundary, according to ONS' classification

+ +
boundary
+

Boundary (short) name, according to ONS' naming

+ +
detail_level
+

Boundary's level of detail. For a detailed description of the methodology refer to Digital boundaries

+ +
year
+

Year in which the boundaries were created

+ +
url_download
+

URL querying the API service to return all features as a geojson file

+ + + +
+
+

Source

+

https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/

+
+ +
+ + +
+ + + + + + + diff --git a/search.json b/search.json index 9ce971c..5829eb0 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://warwickcim.github.io/ukgeographies/articles/ukgeographies.html","id":"notes-on-url-patterns","dir":"Articles","previous_headings":"","what":"Notes on URL patterns:","title":"ukgeographies","text":"Countries (December 2022) Boundaries GB BUC: https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Countries_December_2022_GB_BUC/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Countries (December 2019) Boundaries GB BUC: https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Countries_Dec_2019_UGCB_GB_2022/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Counties (December 2021) Boundaries EN BGC : https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Counties_December_2021_EN_BGC_2022/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Counties (December 2021) Boundaries EN BFC https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Counties_December_2021_EN_BFC_2022/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Counties (May 2023) Boundaries EN BFC: https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Counties_May_2023_Boundaries_EN_BFC/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Combined Authorities (December 2022) Boundaries EN BUC :https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Combined_Authorities_December_2022_EN_BUC/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Countries (December 2019) Boundaries GB BUC: Another option dataframe possible URLs retrieve ","code":""},{"path":"https://warwickcim.github.io/ukgeographies/articles/ukgeographies.html","id":"components","dir":"Articles","previous_headings":"Notes on URL patterns:","what":"Components","title":"ukgeographies","text":"Clipping / Resolution: BFC: Full resolution - clipped coastline (Mean High Water mark) BFE: Full resolution - extent realm (usually Mean Low Water mark , cases, boundaries extend beyond include offshore islands) BGC: Generalised (20m) - clipped coastline (Mean High Water mark) BUC: Ultra Generalised (500m) - clipped coastline (Mean High Water mark)","code":""},{"path":"https://warwickcim.github.io/ukgeographies/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Carlos Cámara-Menoyo. Author, maintainer.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Cámara-Menoyo C (2024). ukgeographies: Downloads UK Geographies ONS' Geoportal. R package version 0.0.0.9000, https://warwickcim.github.io/ukgeographies/, https://github.com/WarwickCIM/ukgeographies.","code":"@Manual{, title = {ukgeographies: Downloads UK Geographies From ONS' Geoportal}, author = {Carlos Cámara-Menoyo}, year = {2024}, note = {R package version 0.0.0.9000, https://warwickcim.github.io/ukgeographies/}, url = {https://github.com/WarwickCIM/ukgeographies}, }"},{"path":"https://warwickcim.github.io/ukgeographies/index.html","id":"ukgeographies","dir":"","previous_headings":"","what":"Downloads UK Geographies From ONS' Geoportal","title":"Downloads UK Geographies From ONS' Geoportal","text":"still WIP. goal UKgeogRaphies retrieve geospatial data ONS’ Geoportal make usable within R. far provides limited functionality download boundaries UK convert sf objects.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Downloads UK Geographies From ONS' Geoportal","text":"can install development version ukgeographies GitHub :","code":"# install.packages(\"devtools\") devtools::install_github(\"WarwickCIM/ukgeographies\")"},{"path":"https://warwickcim.github.io/ukgeographies/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Downloads UK Geographies From ONS' Geoportal","text":"basic example shows solve common problem: ’ll still need render README.Rmd regularly, keep README.md --date. devtools::build_readme() handy .","code":"library(ukgeographies) ## basic example code countries_2022 <- get_boundaries(\"countries\", 2022, \"BUC\") class(countries_2022) #> [1] \"sf\" \"tbl_df\" \"tbl\" \"data.frame\" countries_2022 #> Simple feature collection with 3 features and 11 fields #> Geometry type: MULTIPOLYGON #> Dimension: XY #> Bounding box: xmin: -8.649996 ymin: 49.88234 xmax: 1.763706 ymax: 60.86087 #> Geodetic CRS: WGS 84 #> # A tibble: 3 × 12 #> FID CTRY22CD CTRY22NM CTRY22NMW BNG_E BNG_N LONG LAT Shape__Area #> #> 1 1 E92000001 England Lloegr 394883 370883 -2.08 53.2 130608597662. #> 2 2 S92000003 Scotland Yr Alban 277744 700060 -3.97 56.2 78610512179. #> 3 3 W92000004 Wales Cymru 263405 242881 -3.99 52.1 20792550547. #> # ℹ 3 more variables: Shape__Length , GlobalID , #> # geometry plot(countries_2022[\"CTRY22NM\"])"},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Geographical Boundaries — boundaries_get","title":"Retrieve Geographical Boundaries — boundaries_get","text":"Queries ONS' Geoportal endpoints retrieves requested geographical boundaries form sf object.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Geographical Boundaries — boundaries_get","text":"","code":"boundaries_get(boundary, year, detail_level = \"BUC\")"},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Geographical Boundaries — boundaries_get","text":"boundary string containing ... Accepted values : CAUTH, CED, CTRY, CTY, CTYUA, LAD, LPA, LSOA, MCTY, MSOA, OA, PAR, PARNCP, RGN, UTLA, WD year number containing... detail_level string defining level detail geometry. Accepted values : BFC, BFE, BGC, BUC. value corresponds : Full Extent (BFE) – Full resolution boundaries go Extent Realm (Low Water Mark) detailed boundaries. Full Clipped (BFC) – Full resolution boundaries clipped coastline (Mean High Water mark). Generalised Clipped (BGC) - Generalised 20m clipped coastline (Mean High Water mark) generalised BFE boundaries. Super Generalised Clipped (BSC) (200m) – Generalised 200m clipped coastline (Mean High Water mark). Ultra Generalised Clipped (BUC) (500m) – Generalised 500m clipped coastline (Mean High Water mark). Grid, Extent (BGE) - Grid formed equally sized cells extend beyond coastline. Generalised, Grid (BGG) - Generalised 50m grid squares. detailed description methodology refer Digital boundaries","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Geographical Boundaries — boundaries_get","text":"sf object selected boundaries","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Geographical Boundaries — boundaries_get","text":"","code":"CA_2023_BGC <- boundaries_get(\"CAUTH\", 2023, \"BGC\") class(CA_2023_BGC) #> [1] \"sf\" \"tbl_df\" \"tbl\" \"data.frame\""}] +[{"path":"https://warwickcim.github.io/ukgeographies/articles/ukgeographies.html","id":"notes-on-url-patterns","dir":"Articles","previous_headings":"","what":"Notes on URL patterns:","title":"ukgeographies","text":"Countries (December 2022) Boundaries GB BUC: https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Countries_December_2022_GB_BUC/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Countries (December 2019) Boundaries GB BUC: https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Countries_Dec_2019_UGCB_GB_2022/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Counties (December 2021) Boundaries EN BGC : https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Counties_December_2021_EN_BGC_2022/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Counties (December 2021) Boundaries EN BFC https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Counties_December_2021_EN_BFC_2022/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Counties (May 2023) Boundaries EN BFC: https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Counties_May_2023_Boundaries_EN_BFC/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Combined Authorities (December 2022) Boundaries EN BUC :https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/Combined_Authorities_December_2022_EN_BUC/FeatureServer/0/query?outFields=*&=1%3D1&f=geojson Countries (December 2019) Boundaries GB BUC: Another option dataframe possible URLs retrieve ","code":""},{"path":"https://warwickcim.github.io/ukgeographies/articles/ukgeographies.html","id":"components","dir":"Articles","previous_headings":"Notes on URL patterns:","what":"Components","title":"ukgeographies","text":"Clipping / Resolution: BFC: Full resolution - clipped coastline (Mean High Water mark) BFE: Full resolution - extent realm (usually Mean Low Water mark , cases, boundaries extend beyond include offshore islands) BGC: Generalised (20m) - clipped coastline (Mean High Water mark) BUC: Ultra Generalised (500m) - clipped coastline (Mean High Water mark)","code":""},{"path":"https://warwickcim.github.io/ukgeographies/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Carlos Cámara-Menoyo. Author, maintainer.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Cámara-Menoyo C (2024). ukgeographies: Downloads UK Geographies ONS' Geoportal. R package version 0.0.0.9000, https://warwickcim.github.io/ukgeographies/, https://github.com/WarwickCIM/ukgeographies.","code":"@Manual{, title = {ukgeographies: Downloads UK Geographies From ONS' Geoportal}, author = {Carlos Cámara-Menoyo}, year = {2024}, note = {R package version 0.0.0.9000, https://warwickcim.github.io/ukgeographies/}, url = {https://github.com/WarwickCIM/ukgeographies}, }"},{"path":"https://warwickcim.github.io/ukgeographies/index.html","id":"ukgeographies","dir":"","previous_headings":"","what":"Downloads UK Geographies From ONS' Geoportal","title":"Downloads UK Geographies From ONS' Geoportal","text":"still WIP. goal UKgeogRaphies retrieve geospatial data ONS’ Geoportal make usable within R. far provides limited functionality download boundaries UK convert sf objects.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Downloads UK Geographies From ONS' Geoportal","text":"can install development version ukgeographies GitHub :","code":"# install.packages(\"devtools\") devtools::install_github(\"WarwickCIM/ukgeographies\")"},{"path":"https://warwickcim.github.io/ukgeographies/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Downloads UK Geographies From ONS' Geoportal","text":"basic example shows solve common problem: ’ll still need render README.Rmd regularly, keep README.md --date. devtools::build_readme() handy .","code":"library(ukgeographies) ## basic example code countries_2022 <- get_boundaries(\"countries\", 2022, \"BUC\") class(countries_2022) #> [1] \"sf\" \"tbl_df\" \"tbl\" \"data.frame\" countries_2022 #> Simple feature collection with 3 features and 11 fields #> Geometry type: MULTIPOLYGON #> Dimension: XY #> Bounding box: xmin: -8.649996 ymin: 49.88234 xmax: 1.763706 ymax: 60.86087 #> Geodetic CRS: WGS 84 #> # A tibble: 3 × 12 #> FID CTRY22CD CTRY22NM CTRY22NMW BNG_E BNG_N LONG LAT Shape__Area #> #> 1 1 E92000001 England Lloegr 394883 370883 -2.08 53.2 130608597662. #> 2 2 S92000003 Scotland Yr Alban 277744 700060 -3.97 56.2 78610512179. #> 3 3 W92000004 Wales Cymru 263405 242881 -3.99 52.1 20792550547. #> # ℹ 3 more variables: Shape__Length , GlobalID , #> # geometry plot(countries_2022[\"CTRY22NM\"])"},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Geographical Boundaries — boundaries_get","title":"Retrieve Geographical Boundaries — boundaries_get","text":"Queries ONS' Geoportal endpoints retrieves requested geographical boundaries form sf object.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Geographical Boundaries — boundaries_get","text":"","code":"boundaries_get(boundary, year = NULL, detail_level = \"BUC\")"},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Geographical Boundaries — boundaries_get","text":"boundary string containing ... Accepted values : CAUTH, CED, CTRY, CTY, CTYUA, LAD, LPA, LSOA, MCTY, MSOA, OA, PAR, PARNCP, RGN, UTLA, WD year number containing... detail_level string defining level detail geometry. Accepted values : BFC, BFE, BGC, BUC. value corresponds : Full Extent (BFE) – Full resolution boundaries go Extent Realm (Low Water Mark) detailed boundaries. Full Clipped (BFC) – Full resolution boundaries clipped coastline (Mean High Water mark). Generalised Clipped (BGC) - Generalised 20m clipped coastline (Mean High Water mark) generalised BFE boundaries. Super Generalised Clipped (BSC) (200m) – Generalised 200m clipped coastline (Mean High Water mark). Ultra Generalised Clipped (BUC) (500m) – Generalised 500m clipped coastline (Mean High Water mark). Grid, Extent (BGE) - Grid formed equally sized cells extend beyond coastline. Generalised, Grid (BGG) - Generalised 50m grid squares. detailed description methodology refer Digital boundaries","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Geographical Boundaries — boundaries_get","text":"sf object selected boundaries","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/boundaries_get.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Geographical Boundaries — boundaries_get","text":"","code":"CA_2023_BGC <- boundaries_get(\"CAUTH\", 2023, \"BGC\") class(CA_2023_BGC) #> [1] \"sf\" \"tbl_df\" \"tbl\" \"data.frame\""},{"path":"https://warwickcim.github.io/ukgeographies/reference/ons_boundaries.html","id":null,"dir":"Reference","previous_headings":"","what":"ONS Boundaries — ons_boundaries","title":"ONS Boundaries — ons_boundaries","text":"Metadata subset geographical boundaries ONS' geoportal can downloaded {ukgeographies}. boundaries retrieved services provided ONS' geoportal API automatically categorised URLS, match Geoportal's menus datasets.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/ons_boundaries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"ONS Boundaries — ons_boundaries","text":"","code":"ons_boundaries"},{"path":"https://warwickcim.github.io/ukgeographies/reference/ons_boundaries.html","id":"format","dir":"Reference","previous_headings":"","what":"Format","title":"ONS Boundaries — ons_boundaries","text":"data frame 513 rows 7 columns: id unique identifier every boundary service URL pointing API service boundary_type Type boundary, according ONS' classification boundary Boundary (short) name, according ONS' naming detail_level Boundary's level detail. detailed description methodology refer Digital boundaries year Year boundaries created url_download URL querying API service return features geojson file","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/ons_boundaries.html","id":"source","dir":"Reference","previous_headings":"","what":"Source","title":"ONS Boundaries — ons_boundaries","text":"https://services1.arcgis.com/ESMARspQHYMw9BZ9/arcgis/rest/services/","code":""}] diff --git a/sitemap.xml b/sitemap.xml index 63415ae..4b9622d 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -21,4 +21,7 @@ https://warwickcim.github.io/ukgeographies/reference/index.html + + https://warwickcim.github.io/ukgeographies/reference/ons_boundaries.html +