rgeoapi — A package to access the GéoAPI

1 minute read

rgeoapi connects R to the GéoAPI, in order to get information about french geography.

rgeoapi is now on CRAN

rgeoapi

This package requests informations from the French GeoAPI inside R — https://api.gouv.fr/explorer/geoapi/

GeoAPI

Developped by Etalab, with La Poste, l’INSEE and OpenStreetMap, the GeoAPI API is a JSON interface designed to make requests on the French geographic database.

rgeoapi was developped to facilitate your geographic projects by giving you access to these informations straight inside R. With rgeoapi, you can get any coordinate, size and population of a French city, to be used in your maps.

For an optimal compatibility, all the names (especially outputs) used in this package are the same as the ones used in the GeoAPI. Please note that this package works only with French cities.

Install this package directly in R :

devtools::install_github"ColinFay/rgeoapi")

How rgeoapi works

The version 1.0.0 works with eleven functions. Which are :

  • `ComByCode` Get City by INSEE Code
  • `ComByCoord` Get City by Coordinates
  • `ComByDep` Get Cities by Department
  • `ComByName` Get City by Name
  • `ComByPostal` Get City by Postal Code
  • `ComByReg` Get Cities by Region
  • `DepByCode` Get Department by INSEE Code
  • `DepByName` Get Department by Name
  • `DepByReg` Get Departments by Region
  • `RegByCode` Get Region by INSEE Code
  • `RegByName` Get Region by Name

How the functions are constructed

In the GeoAPI, you can request for “Commune”, “Département” or “Région”. All the functions are constructed using this terminology : AByB.

  • A being the output you need -- Com for "Commune" (refering to French cities), Dep for Département (for Department) and Reg for Région.
  • B being the request parameter -- Code for INSEE Code, Coord for Coordinates (WGS-84), Dep for Department, Name for name, Postal for Postal Code and Reg for Region.

French Tutorial & contact

A French tutorial on my website. Questions and feedbacks welcome !

Categories:

Updated: