Mise à jour du package R : rgeoapi

2 minute(s) read

L’API GéoAPI a subi des modifications récentes, qui ont nécessité une mise à jour du package R permettant d’interroger cette ressource.

Mise à jour de la GéoAPI

L’API GéoAPI est une interface JSON qui permet d’interroger la base de données géographiques française. rgeoapi a été développé afin de faciliter le travail de cartographie avec R — avec ce package, vous pouvez obtenir toutes les informations nécessaires sur les communes françaises.

À noter : le format des fonctions a été modifié par rapport à la version précédente du package, développée pour la version beta de la GéoAPI. La nouvelle version incluant des requêtes par département et région (pas seulement par ville), le format getBy de la version précédente n’était plus pertinent. De plus, une terminologie dans le contenu JSON ayant changé, certains paramètres renvoyaient du NA. Si vous avez l’ancienne version, il est conseillé d’effectuer la mise à jour.

Installer rgeoapi

Pour installer le package dans R depuis GitHub :

devtools::install_github("ColinFay/rgeoapi")

Comment fonctionne rgeoapi

Cette version 1.0.0 comprend 11 fonctions :

  • `ComByCode` obtenir une commune par son code INSEE
  • `ComByCoord` obtenir une commune par ses coordonnées géographiques (WGS-84)
  • `ComByDep` obtenir toutes les communes d'un département
  • `ComByName` obtenir une ou plusieurs commune(s) par un nom
  • `ComByPostal` obtenir une commune par son code postal
  • `ComByReg` obtenir toutes les communes d'une région
  • `DepByCode` obtenir un département par son code INSEE
  • `DepByName` obtenir un ou plusieurs département(s) par un nom
  • `DepByReg` obtenir tous les départements d'une région
  • `RegByCode` obtenir une région par son code INSEE
  • `RegByName` obtenir une région par son nom

Comment sont construites les fonctions

Dans la GéoAPI, vous pouvez effectuer des requêtes pour : “Commune”, “Département” ou “Région”. Pour une compatibilité maximale, les termes utilisés dans ce package respecte celle de l’API, notamment pour les outputs.

Toutes les fonctions de ce package suivent la structure : AByB.

  • A étant vos données de sorties souhaitées – Com pour “Commune”, Dep pour "Département" et Reg pour "Région".
  • B étant le paramètre de la requête – Code pour un code INSEE, Coord pour les coordonées (WGS-84), Dep pour le département, Name pour le nom, Postal pour le code postal et Reg pour la région.

Quelques examples

ComByCoord

Cette fonction prend la latitude et la longitude d’une ville, et retourne un data.frame avec : nom, code INSEE (ville / département / région), code postal, population approximative, surface en hectares, et coordonnées.

ComByCoord(lat = "48.11023", lon = "-1.678872") 

DepByName

Cette fonction prend un nom et retourne un data.frame avec le ou les nom(s), les codes INSEE, et le score de pertinence typographique de chaque réponse. Des requêtes partielles peuvent être effectuées.

DepByName("morbihan")
DepByName("Il")

RegByCode

Cette fonction prend un code INSEE de région, et renvoie un data.frame avec le nom et le code de la région.

RegByCode(53)

Contact

Vos questions et feedbacks sont les bienvenus !

What do you think?