Skip to content

Commit

Permalink
Deploying to gh-pages from @ d43c1d8 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
ccamara committed Jun 28, 2024
1 parent d67260e commit acdfa81
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 7 deletions.
2 changes: 1 addition & 1 deletion pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pkgdown: 2.0.9
pkgdown_sha: ~
articles:
ukgeographies: ukgeographies.html
last_built: 2024-06-27T12:12Z
last_built: 2024-06-28T22:26Z
urls:
reference: https://warwickcim.github.io/ukgeographies/reference
article: https://warwickcim.github.io/ukgeographies/articles
Expand Down
Binary file added reference/Rplot001.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 25 additions & 5 deletions reference/get_boundaries.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion search.json
Original file line number Diff line number Diff line change
@@ -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 #> <int> <chr> <chr> <chr> <int> <int> <dbl> <dbl> <dbl> #> 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 <dbl>, GlobalID <chr>, #> # geometry <MULTIPOLYGON [°]> plot(countries_2022[\"CTRY22NM\"])"},{"path":"https://warwickcim.github.io/ukgeographies/reference/get_boundaries.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Geographical Boundary — get_boundaries","title":"Retrieve Geographical Boundary — get_boundaries","text":"Queries ONS' Geoportal endpoints retrieves requested geographical boundaries form sf object.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/get_boundaries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Geographical Boundary — get_boundaries","text":"","code":"get_boundaries(boundary, year, resolution = \"BUC\")"},{"path":"https://warwickcim.github.io/ukgeographies/reference/get_boundaries.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Geographical Boundary — get_boundaries","text":"boundary string containing... year number containing... resolution string containing...","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/get_boundaries.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Geographical Boundary — get_boundaries","text":"sf object","code":""}]
[{"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 #> <int> <chr> <chr> <chr> <int> <int> <dbl> <dbl> <dbl> #> 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 <dbl>, GlobalID <chr>, #> # geometry <MULTIPOLYGON [°]> plot(countries_2022[\"CTRY22NM\"])"},{"path":"https://warwickcim.github.io/ukgeographies/reference/get_boundaries.html","id":null,"dir":"Reference","previous_headings":"","what":"Retrieve Geographical Boundary — get_boundaries","title":"Retrieve Geographical Boundary — get_boundaries","text":"Queries ONS' Geoportal endpoints retrieves requested geographical boundaries form sf object.","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/get_boundaries.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Retrieve Geographical Boundary — get_boundaries","text":"","code":"get_boundaries(boundary, year, detail_level = \"BUC\")"},{"path":"https://warwickcim.github.io/ukgeographies/reference/get_boundaries.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Retrieve Geographical Boundary — get_boundaries","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/get_boundaries.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Retrieve Geographical Boundary — get_boundaries","text":"sf object selected boundaries","code":""},{"path":"https://warwickcim.github.io/ukgeographies/reference/get_boundaries.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Retrieve Geographical Boundary — get_boundaries","text":"","code":"CA_2023_BGC <- get_boundaries(\"Combined Authorities\", 2023, \"BGC\") #> Error in get_boundaries(\"Combined Authorities\", 2023, \"BGC\"): object 'resolution' not found class(CA_2023_BGC) #> Error in eval(expr, envir, enclos): object 'CA_2023_BGC' not found"}]

0 comments on commit acdfa81

Please sign in to comment.