PostcodesioR

Código postalioR

Código postalioR

Un contenedor de API para postcodes.io: búsqueda gratuita de códigos postales y geocodificador del Reino Unido. Este paquete ayuda a encontrar y transformar información sobre la geografía administrativa del Reino Unido, como códigos postales, LSOA, MSOA, distritos electorales, condados, distritos, CCG o NUTS.

El paquete se basa exclusivamente en datos abiertos proporcionados por postcodes.io. PostcodesioR puede ser utilizado por científicos de datos o científicos sociales que trabajen con datos geocodificados del Reino Unido. Una tarea común cuando se trabaja con este tipo de datos es agregar datos geocodificados en diferentes niveles administrativos, por ejemplo, convertir datos a nivel de código postal en condados o regiones. Este paquete puede ayudar a lograr esto y en muchos otros casos cuando se requiere cambiar la agregación de datos geográficos.

Instalación

Este paquete se puede instalar desde GitHub (versión de desarrollo) o CRAN (estable).

Para instalar PostcodesioR utilice uno de los siguientes comandos:

 # stable version
install.packages( " PostcodesioR " )

o

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

Cargando

Cargue el paquete escribiendo

library( PostcodesioR )

Ejemplos

Siempre que fue posible, intenté devolver un marco de datos. Desafortunadamente, muchas llamadas API devuelven datos más complejos y, en esos casos, es más seguro utilizar listas. La API limita la cantidad de llamadas devueltas. Consulte la documentación de funciones para obtener más detalles.

Para obtener información adicional sobre los datos devueltos y las llamadas a funciones, consulte la documentación original.

La función principal de este paquete proporciona información relacionada con un código postal determinado.

 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"

Consulte la viñeta para ver todas las funciones en acción.

Citación

Por favor cite este paquete si se utiliza en una publicación.

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

La entrada de BibTeX está aquí:

@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/},
}

Notas

Actualmente, existe un límite en la cantidad de llamadas API que se pueden realizar. Sin embargo, postcodes.io proporciona una lista completa de datos de geolocalización que se pueden utilizar localmente sin limitaciones. Los datos originales provienen del Portal de Datos de la Oficina de Estadísticas Nacionales. Ese archivo es bastante grande por lo que no lo incluí en el paquete.

Vaya al sitio web del paquete o a mi blog para ver más ejemplos.

Código de conducta

Tenga en cuenta que este proyecto se publica con un Código de conducta para colaboradores. Al participar en este proyecto, usted acepta cumplir con sus términos.