happign

happign - IGN API for R

CRAN status CRAN checks R-CMD-check license Codecov test coverage Lifecycle: experimental

The goal of happign is to facilitate the use of Application Programming Interface from the French National Institute of Geographic and Forestry Information to retrieve their free resources. happign allow downloading of :

and calculation of :

Context

Since January 1, 2021, the French National Institute for Geographic and Forestry Information (IGN) has made its public data on French topography, infrastructure, and terrain freely available. The opening of IGN data under the Etalab 2.0 open license means free access and use for all.

Among the important data that are now open, we can mention the BD TOPO (3D modeling of the territory and its infrastructures), the BD ORTHO (departmental orthophotography), the BD Forêt and the RGE Alti (meshed digital terrain model that describes the French relief). This represents 100 terabytes of data.

To facilitate access to this data, IGN has implemented a set of APIs based on OGC standards. In other words, it is possible, with correctly formatted URLs, to access IGN data. In spite of a well supplied documentation, the use of APIs remains complex to set up. The happign package has been created to facilitate this.

Rights of use for IGN data

Data from IGN geoservice website are free and available in open license according to the principle of the Etalab 2.0 license since January 1, 2021. Other data complete the IGN’s open data policy since June 1st, 2021. SCAN 25®, SCAN 100® and SCAN OACI data are free to download or stream, but any professional or individual wishing to develop a commercial paper or digital offer for the general public will have to pay a fee according to the General Conditions of Use.

Installation

You can install the released version of happign from CRAN with:

install.packages("happign")

And the development version from GitHub with:

# install.packages("devtools")
devtools::install_github("paul-carteron/happign")

Vignettes

Package vignettes :

Future features

IGN offers other services. Their implementation in R is under development :

Problems and Issues

System Requirements

happign requires R v >= 4.1.0.

Why it’s called happign ?

This project is - obviously - called happign, here’s why :

Also, for the most attentive to details, you can see on the logo a green leaf stuck between the teeth of the charming smile. It is none other than the leaf from the IGN logo.

Code of Conduct

Please note that the happign project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.