PostcodesioR

Code postalioR

Code postalioR

Un wrapper API autour de postcodes.io - recherche et géocodeur gratuits de codes postaux au Royaume-Uni. Ce package permet de rechercher et de transformer des informations sur la géographie administrative du Royaume-Uni telles que les codes postaux, LSOA, MSOA, circonscriptions, comtés, quartiers, districts, CCG ou NUTS.

Le package est basé exclusivement sur des données ouvertes fournies par postcodes.io. PostcodesioR peut être utilisé par des data scientists ou des spécialistes des sciences sociales travaillant avec des données géocodées au Royaume-Uni. Une tâche courante lorsque l'on travaille avec de telles données consiste à agréger des données géocodées à différents niveaux administratifs, par exemple en transformant les données au niveau du code postal en comtés ou régions. Ce package peut aider à y parvenir et dans de nombreux autres cas lorsqu'une modification de l'agrégation des données géographiques est requise.

Installation

Ce package peut être installé depuis GitHub (version de développement) ou CRAN (stable).

Pour installer PostcodesioR, utilisez l'une des commandes suivantes :

 # stable version
install.packages( " PostcodesioR " )

ou

 # developmental version
if ( ! require( " devtools " )) {
  install.packages( " devtools " )
}
devtools :: install_github( " ropensci/PostcodesioR " )

Chargement

Chargez le package en tapant

library( PostcodesioR )

Exemples

Dans la mesure du possible, j'ai essayé de renvoyer une trame de données. Malheureusement, de nombreux appels d'API renvoient des données plus complexes et dans ces cas, il est plus sûr d'utiliser des listes. L'API limite le nombre d'appels renvoyés. Consultez la documentation des fonctions pour plus de détails.

Pour plus d'informations sur les données renvoyées et les appels de fonction, consultez la documentation d'origine.

La fonction principale de ce package fournit des informations relatives à un code postal donné

 lookup_result <- postcode_lookup( " EC1Y8LX " )

# overview
str( lookup_result )

 ## 'data.frame':    1 obs. of  38 variables:
##  $ postcode                       : chr "EC1Y 8LX"
##  $ quality                        : int 1
##  $ eastings                       : int 532544
##  $ northings                      : int 182128
##  $ country                        : chr "England"
##  $ nhs_ha                         : chr "London"
##  $ longitude                      : num -0.0909
##  $ latitude                       : num 51.5
##  $ european_electoral_region      : chr "London"
##  $ primary_care_trust             : chr "Islington"
##  $ region                         : chr "London"
##  $ lsoa                           : chr "Islington 023D"
##  $ msoa                           : chr "Islington 023"
##  $ incode                         : chr "8LX"
##  $ outcode                        : chr "EC1Y"
##  $ parliamentary_constituency     : chr "Islington South and Finsbury"
##  $ admin_district                 : chr "Islington"
##  $ parish                         : chr "Islington, unparished area"
##  $ admin_county                   : logi NA
##  $ date_of_introduction           : chr "198001"
##  $ admin_ward                     : chr "Bunhill"
##  $ ced                            : logi NA
##  $ ccg                            : chr "NHS North Central London"
##  $ nuts                           : chr "Haringey and Islington"
##  $ pfa                            : chr "Metropolitan Police"
##  $ admin_district_code            : chr "E09000019"
##  $ admin_county_code              : chr "E99999999"
##  $ admin_ward_code                : chr "E05013699"
##  $ parish_code                    : chr "E43000209"
##  $ parliamentary_constituency_code: chr "E14000764"
##  $ ccg_code                       : chr "E38000240"
##  $ ccg_id_code                    : chr "93C"
##  $ ced_code                       : chr "E99999999"
##  $ nuts_code                      : chr "TLI43"
##  $ lsoa_code                      : chr "E01002704"
##  $ msoa_code                      : chr "E02000576"
##  $ lau2_code                      : chr "E09000019"
##  $ pfa_code                       : chr "E23000001"

Consultez la vignette pour voir toutes les fonctions en action.

Citation

Veuillez citer ce package s'il est utilisé dans une publication

Walczak, EJ, (2023). PostcodesioR: An R package for UK geocoding. Journal of Open Source Software, 8(84), 5334, https://doi.org/10.21105/joss.05334

L'entrée BibTeX est ici :

@article{postcodesior:2023,
  title = {{PostcodesioR: An R package for UK geocoding}},
  author = {Eryk J. Walczak},
  journal = {Journal of Open Source Software},
  volume = {8},
  number = {84},
  pages = {5334},
  year = {2023},
  doi = {10.21105/joss.05334},
  note = {R package version 0.3.1},
  url = {https://cran.r-project.org/web/packages/PostcodesioR/},
}

Remarques

Actuellement, il existe une limite au nombre d’appels API pouvant être effectués. Cependant, postcodes.io fournit une liste complète des données de géolocalisation qui peuvent être utilisées localement sans limitations. Les données originales proviennent du portail de données de l'Office for National Statistics. Ce fichier est plutôt volumineux, je ne l'ai donc pas inclus dans le package.

Allez sur le site Web du package ou sur mon blog pour plus d'exemples.

Code de conduite

Veuillez noter que ce projet est publié avec un code de conduite des contributeurs. En participant à ce projet, vous acceptez d'en respecter les termes.