happign

Happign allows you to use the APIs provided by the IGN (France) to download their public data.

https://github.com/paul-carteron/happign

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (18.6%) to scientific vocabulary

Last synced: 10 months ago · JSON representation

Repository

Happign allows you to use the APIs provided by the IGN (France) to download their public data.

Basic Info

Host: GitHub
Owner: paul-carteron
License: gpl-3.0
Language: R
Default Branch: main
Homepage: https://paul-carteron.github.io/happign/
Size: 469 MB

Statistics

Stars: 32
Watchers: 2
Forks: 3
Open Issues: 7
Releases: 11

Created over 4 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct

README.Rmd

---
output: github_document
---



```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# happign 

# happign - IGN data from R


[![R-CMD-check](https://github.com/paul-carteron/happign/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/paul-carteron/happign/actions/workflows/R-CMD-check.yaml)
[![CRAN status](https://www.r-pkg.org/badges/version/happign)](https://CRAN.R-project.org/package=happign)
[![downloads](https://cranlogs.r-pkg.org/badges/last-month/happign?color=green)](https://cran.r-project.org/package=happign)
[![Codecov test coverage](https://codecov.io/gh/paul-carteron/happign/branch/main/graph/badge.svg)](https://app.codecov.io/gh/paul-carteron/happign?branch=main)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)


The goal of happign is to facilitate the use of Web Services and API from the IGN (French National Institute of Geographic and Forestry Information). `happign` allow downloading of :

- Shapefile via use of WFS service and [APIcarto](https://apicarto.ign.fr/api/doc/) ;
- Raster via use of WMS raster service

### Context

Since January 1, 2021, the French National Institute for Geographic and Forestry Information (IGN) has opened access to their 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.


To facilitate accessibility, IGN has implemented a set of APIs and Web services based on OGC standards. Despite a well supplied documentation, the use of APIs and Web services remains complex to set up in R. The `happign` package has been created to make it easier.

### Rights of use for IGN data

Data from [IGN geoservice website](https://geoservices.ign.fr/presentation) are free and available in open license according to the principle of the [Etalab 2.0 license](https://www.etalab.gouv.fr/licence-ouverte-open-licence/) 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](https://geoservices.ign.fr/cgu-licences).

### Installation

You can install the released version of happign from [CRAN](https://CRAN.R-project.org) with:

``` r
install.packages("happign")
```

And the development version from [GitHub](https://github.com/) with:

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

### Vignettes

Package vignettes :

- [Getting started](https://paul-carteron.github.io/happign/articles/getting_started.html) : A brief intro to happign world ;
- [happign for foresters](https://paul-carteron.github.io/happign/articles/web_only/happign_for_foresters.html) : A focus on possibilities offered by happign for forestry ;
- [API carto](https://paul-carteron.github.io/happign/articles/web_only/api_carto.html) : How to use all API Carto with happign ;

### Future features

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

- Implement isochrone and isodistance calculation

### Problems and Issues

* Please report any issues or bugs you may encounter on the [dedicated page on github](https://github.com/paul-carteron/happign/issues).

### System Requirements
`happign` requires [`R`](https://cran.r-project.org) v >= 4.1.0.

### Why it's called `happign` ?

This project is - obviously - called happign; here's why :

- “ign” stand for… IGN : the acronym of the institute ;
- “api” stand for… API : one of the interface used to retrieve the data;
- and the addition of an “h” and another “p” for the pun with “happy”. Besides the fact that I love this kind of humor, the simplified use of APIs is a real source of happiness, trust me.

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](https://paul-carteron.github.io/happign/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

Owner

Name: Paul CARTERON
Login: paul-carteron
Kind: user

Repositories: 1
Profile: https://github.com/paul-carteron

GitHub Events

Total

Create event: 4
Release event: 4
Issues event: 27
Watch event: 3
Issue comment event: 40
Push event: 124
Pull request event: 2

Last Year

Create event: 4
Release event: 4
Issues event: 27
Watch event: 3
Issue comment event: 40
Push event: 124
Pull request event: 2

Committers

Last synced: over 2 years ago

All Time

Total Commits: 499
Total Committers: 2
Avg Commits per committer: 249.5
Development Distribution Score (DDS): 0.034

Past Year

Commits: 131
Committers: 2
Avg Commits per committer: 65.5
Development Distribution Score (DDS): 0.023

Top Committers

Name	Email	Commits
Paul CARTERON	c**l@g**m	482
Paul CARTERON	6****n	17

Issues and Pull Requests

Last synced: 11 months ago

All Time

Total issues: 33
Total pull requests: 5
Average time to close issues: about 2 months
Average time to close pull requests: 2 days
Total issue authors: 13
Total pull request authors: 3
Average comments per issue: 2.15
Average comments per pull request: 0.2
Merged pull requests: 4
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 9
Pull requests: 1
Average time to close issues: 7 days
Average time to close pull requests: N/A
Issue authors: 6
Pull request authors: 1
Average comments per issue: 2.22
Average comments per pull request: 0.0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

paul-carteron (15)
mgageo (7)
lionel68 (2)
DDorch (1)
MayeulDvl (1)
adns-dev (1)
Enchufa2 (1)
MiloMonnier (1)
vineus-cyber (1)
Florent-Demoraes (1)
richaben (1)
MichaelRabotin (1)
sylvaine31 (1)

Pull Request Authors

paul-carteron (3)
GrrdJulien (1)
DDorch (1)

Top Labels

Issue Labels

enhancement (6) apicarto (3) get_wms_raster (1) get_lidar (1) get_wmts (1)

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- cran 630 last-month

Total dependent packages: 0
Total dependent repositories: 0
Total versions: 19
Total maintainers: 1

cran.r-project.org: happign

R Interface to 'IGN' Web Services

Homepage: https://github.com/paul-carteron
Documentation: http://cran.r-project.org/web/packages/happign/happign.pdf
License: GPL (≥ 3)
Latest release: 0.3.6
published 11 months ago

Versions: 19
Dependent Packages: 0
Dependent Repositories: 0
Downloads: 630 Last month

Rankings

Stargazers count: 15.6%

Forks count: 21.9%

Average: 27.6%

Dependent packages count: 29.8%

Downloads: 35.1%

Dependent repos count: 35.5%

Maintainers (1)

carteronpaul@gmail.com

Last synced: 11 months ago

Dependencies

DESCRIPTION cran

R >= 2.10 depends
checkmate * imports
curl * imports
dplyr * imports
httr2 * imports
magrittr * imports
sf >= 1.0 imports
stars >= 0.5 imports
tidyr * imports
xml2 * imports
DT * suggests
covr * suggests
httptest2 * suggests
knitr * suggests
rmarkdown * suggests
testthat >= 3.0.0 suggests
tmap * suggests

.github/workflows/R-CMD-check.yaml actions

actions/cache v2 composite
actions/checkout v3 composite
actions/upload-artifact main composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite

.github/workflows/pkgdown.yaml actions

actions/cache v2 composite
actions/checkout v3 composite
r-lib/actions/setup-pandoc v2 composite
r-lib/actions/setup-r v2 composite

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science

happign

Science Score: 26.0%

Repository

Basic Info

Statistics

Metadata Files

README.Rmd

Owner

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

cran.r-project.org: happign

Rankings

Maintainers (1)

Dependencies