Data

Tools

Indexes

Applications

Experiments

Open Source Science

rgeoservices

:package: A R client for the IGN Geoservices API

https://github.com/ahasverus/rgeoservices

Science Score: 44.0%

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

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (16.3%) to scientific vocabulary
Last synced: 7 months ago · JSON representation ·

Repository

:package: A R client for the IGN Geoservices API

Basic Info
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 0
Created about 1 year ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License Code of conduct Citation Codemeta

README.Rmd 

---
output: github_document
---




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



rgeoservices 
=========================================================


![Package](https://img.shields.io/static/v1?message=Package&logo=r&labelColor=5c5c5c&color=yellowgreen&logoColor=white&label=%20)
[![License: GPL (>= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)
![Lifecycle Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)
[![CRAN status](https://www.r-pkg.org/badges/version/rgeoservices)](https://CRAN.R-project.org/package=rgeoservices)

[![R CMD Check](https://github.com/ahasverus/rgeoservices/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/ahasverus/rgeoservices/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/ahasverus/rgeoservices/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/ahasverus/rgeoservices/actions/workflows/pkgdown.yaml)
[![Test coverage](https://github.com/ahasverus/rgeoservices/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/ahasverus/rgeoservices/actions/workflows/test-coverage.yaml)
[![codecov](https://codecov.io/gh/ahasverus/rgeoservices/branch/main/graph/badge.svg)](https://codecov.io/gh/ahasverus/rgeoservices)






  • Overview

  • Features

  • Installation

  • Get started

  • Citation

  • Contributing

  • Acknowledgments





## Overview


The R package `rgeoservices` is a R client streamlining access to the services provided by the French National Institute of Geographic and Forest Information (IGN) through its open access [Geoplatform](https://geoservices.ign.fr/documentation/services/services-geoplateforme). This Geoplatform can be used to query the IGN BD TOPO® database to retrieve geographical information (only for France)



## Features

Currently `rgeoservices` can access to the following services:

- **Geocoding service** [:globe_with_meridians:](https://geoservices.ign.fr/documentation/services/services-geoplateforme/geocodage)

Service used to obtain the geographic coordinates of an address or a point of interest. The reverse operation is also possible. 
See the [`gs_get_geocode()`](https://ahasverus.github.io/rgeoservices/reference/gs_get_geocode.html) and [`gs_get_coordinates()`](https://ahasverus.github.io/rgeoservices/reference/gs_get_coordinates.html) functions.


- **Altimetry service** [:globe_with_meridians:](https://geoservices.ign.fr/documentation/services/services-geoplateforme/altimetrie)

Service used to obtain the altitude of a geographical point and a longitudinal profile. See the [`gs_get_elevation()`](https://ahasverus.github.io/rgeoservices/reference/gs_get_elevation.html) function.

- **Route planner service** [:globe_with_meridians:](https://geoservices.ign.fr/documentation/services/services-geoplateforme/itineraire)

Service used to obtain a route between two points. See the [`gs_get_itinerary()`](https://ahasverus.github.io/rgeoservices/reference/gs_get_itinerary.html) function.

- **Isochrone/Isodistance service** [:globe_with_meridians:](https://geoservices.ign.fr/documentation/services/services-geoplateforme/itineraire)

Service used to get to the accessible area within a certain travel time/distance. See the [`gs_get_isochrone()`](https://ahasverus.github.io/rgeoservices/reference/gs_get_isochrone.html) and [`gs_get_isodistance()`](https://ahasverus.github.io/rgeoservices/reference/gs_get_isodistance.html) functions.



## Installation

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

```{r eval=FALSE}
## Install 'remotes' package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
  install.packages("remotes")
}

## Install 'rgeoservices' from GitHub ----
remotes::install_github("ahasverus/rgeoservices")
```

Then you can attach the package `rgeoservices`:

```{r eval=FALSE}
library("rgeoservices")
```



## Get started

For an overview of the main features of `rgeoservices`, please read the
[Reference](https://ahasverus.github.io/rgeoservices/articles/rgeoservices.html) page.

**N.B.** A vignette will be available soon.



## Citation

Please cite `rgeoservices` as: 

> Casajus Nicolas (`r format(Sys.Date(), "%Y")`) rgeoservices: A R 
client for the IGN Geoservices API. R package version 0.0.0.9000. 




## Contributing

All types of contributions are encouraged and valued. For more information, 
check out our [Contributor Guidelines](https://github.com/ahasverus/rgeoservices/blob/main/CONTRIBUTING.md).

Please note that the `rgeoservices` project is released with a 
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). 
By contributing to this project, you agree to abide by its terms.



## Acknowledgments

I'd like to thank the IGN for making their invaluable data freely available.

Owner

  • Name: Nicolas Casajus
  • Login: ahasverus
  • Kind: user
  • Location: Montpellier, France
  • Company: @FRBCesab

Data scientist

Citation (CITATION.cff) 

# --------------------------------------------
# CITATION file created with {cffr} R package
# See also: https://docs.ropensci.org/cffr/
# --------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "rgeoservices" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'rgeoservices: A R Client for the IGN Geoservices API'
version: 0.0.0.9000
abstract: A set of functions to query the API provided by the French National Institute
  of Geographic and Forest Information (IGN) through its online Geoplateform <https://geoservices.ign.fr/documentation/services/services-geoplateforme>.
authors:
- family-names: Casajus
  given-names: Nicolas
  email: rdev.nc@gmail.com
  orcid: https://orcid.org/0000-0002-5537-5294
preferred-citation:
  type: manual
  title: 'rgeoservices: A R client for the IGN Geoservices API'
  authors:
  - name: Casajus Nicolas
  year: '2025'
  notes: R package version 0.0.0.9000
  url: https://github.com/ahasverus/rgeoservices
repository-code: https://github.com/ahasverus/rgeoservices
url: https://github.com/ahasverus/rgeoservices
contact:
- family-names: Casajus
  given-names: Nicolas
  email: rdev.nc@gmail.com
  orcid: https://orcid.org/0000-0002-5537-5294
references:
- type: software
  title: 'R: A Language and Environment for Statistical Computing'
  notes: Depends
  url: https://www.R-project.org/
  authors:
  - name: R Core Team
  institution:
    name: R Foundation for Statistical Computing
    address: Vienna, Austria
  year: '2025'
  version: '>= 4.2.0'
- type: software
  title: httr2
  abstract: 'httr2: Perform HTTP Requests and Process the Responses'
  notes: Imports
  url: https://httr2.r-lib.org
  repository: https://CRAN.R-project.org/package=httr2
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.httr2
- type: software
  title: sf
  abstract: 'sf: Simple Features for R'
  notes: Imports
  url: https://r-spatial.github.io/sf/
  repository: https://CRAN.R-project.org/package=sf
  authors:
  - family-names: Pebesma
    given-names: Edzer
    email: edzer.pebesma@uni-muenster.de
    orcid: https://orcid.org/0000-0001-8049-7069
  year: '2025'
  doi: 10.32614/CRAN.package.sf
- type: software
  title: geodata
  abstract: 'geodata: Download Geographic Data'
  notes: Suggests
  url: https://github.com/rspatial/geodata/issues/
  repository: https://CRAN.R-project.org/package=geodata
  authors:
  - family-names: Hijmans
    given-names: Robert J.
  - family-names: Barbosa
    given-names: Márcia
  - family-names: Ghosh
    given-names: Aniruddha
  - family-names: Mandel
    given-names: Alex
  year: '2025'
  doi: 10.32614/CRAN.package.geodata
- type: software
  title: ggplot2
  abstract: 'ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics'
  notes: Suggests
  url: https://ggplot2.tidyverse.org
  repository: https://CRAN.R-project.org/package=ggplot2
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
    orcid: https://orcid.org/0000-0003-4757-117X
  - family-names: Chang
    given-names: Winston
    orcid: https://orcid.org/0000-0002-1576-2126
  - family-names: Henry
    given-names: Lionel
  - family-names: Pedersen
    given-names: Thomas Lin
    email: thomas.pedersen@posit.co
    orcid: https://orcid.org/0000-0002-5147-4711
  - family-names: Takahashi
    given-names: Kohske
  - family-names: Wilke
    given-names: Claus
    orcid: https://orcid.org/0000-0002-7470-9261
  - family-names: Woo
    given-names: Kara
    orcid: https://orcid.org/0000-0002-5125-4188
  - family-names: Yutani
    given-names: Hiroaki
    orcid: https://orcid.org/0000-0002-3385-7233
  - family-names: Dunnington
    given-names: Dewey
    orcid: https://orcid.org/0000-0002-9415-4582
  - family-names: Brand
    given-names: Teun
    name-particle: van den
    orcid: https://orcid.org/0000-0002-9335-7468
  year: '2025'
  doi: 10.32614/CRAN.package.ggplot2
- type: software
  title: httptest2
  abstract: 'httptest2: Test Helpers for ''httr2'''
  notes: Suggests
  url: https://enpiar.com/httptest2/
  repository: https://CRAN.R-project.org/package=httptest2
  authors:
  - family-names: Richardson
    given-names: Neal
    email: neal.p.richardson@gmail.com
    orcid: https://orcid.org/0009-0002-7992-3520
  year: '2025'
  doi: 10.32614/CRAN.package.httptest2
- type: software
  title: knitr
  abstract: 'knitr: A General-Purpose Package for Dynamic Report Generation in R'
  notes: Suggests
  url: https://yihui.org/knitr/
  repository: https://CRAN.R-project.org/package=knitr
  authors:
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  year: '2025'
  doi: 10.32614/CRAN.package.knitr
- type: software
  title: mapview
  abstract: 'mapview: Interactive Viewing of Spatial Data in R'
  notes: Suggests
  url: https://github.com/r-spatial/mapview
  repository: https://CRAN.R-project.org/package=mapview
  authors:
  - family-names: Appelhans
    given-names: Tim
    email: tim.appelhans@gmail.com
  - family-names: Detsch
    given-names: Florian
    email: fdetsch@web.de
  - family-names: Reudenbach
    given-names: Christoph
    email: reudenbach@geo.uni-marburg.de
  - family-names: Woellauer
    given-names: Stefan
    email: stephan.woellauer@geo.uni-marburg.de
  year: '2025'
  doi: 10.32614/CRAN.package.mapview
- type: software
  title: rmarkdown
  abstract: 'rmarkdown: Dynamic Documents for R'
  notes: Suggests
  url: https://pkgs.rstudio.com/rmarkdown/
  repository: https://CRAN.R-project.org/package=rmarkdown
  authors:
  - family-names: Allaire
    given-names: JJ
    email: jj@posit.co
  - family-names: Xie
    given-names: Yihui
    email: xie@yihui.name
    orcid: https://orcid.org/0000-0003-0645-5666
  - family-names: Dervieux
    given-names: Christophe
    email: cderv@posit.co
    orcid: https://orcid.org/0000-0003-4474-2498
  - family-names: McPherson
    given-names: Jonathan
    email: jonathan@posit.co
  - family-names: Luraschi
    given-names: Javier
  - family-names: Ushey
    given-names: Kevin
    email: kevin@posit.co
  - family-names: Atkins
    given-names: Aron
    email: aron@posit.co
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  - family-names: Cheng
    given-names: Joe
    email: joe@posit.co
  - family-names: Chang
    given-names: Winston
    email: winston@posit.co
  - family-names: Iannone
    given-names: Richard
    email: rich@posit.co
    orcid: https://orcid.org/0000-0003-3925-190X
  year: '2025'
  doi: 10.32614/CRAN.package.rmarkdown
- type: software
  title: testthat
  abstract: 'testthat: Unit Testing for R'
  notes: Suggests
  url: https://testthat.r-lib.org
  repository: https://CRAN.R-project.org/package=testthat
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2025'
  doi: 10.32614/CRAN.package.testthat
  version: '>= 3.0.0'

CodeMeta (codemeta.json) 

{
  "@context": "https://doi.org/10.5063/schema/codemeta-2.0",
  "@type": "SoftwareSourceCode",
  "identifier": "rgeoservices",
  "description": "A set of functions to query the API provided by the French National Institute of Geographic and Forest Information (IGN) through its online Geoplateform <https://geoservices.ign.fr/documentation/services/services-geoplateforme>.",
  "name": "rgeoservices: A R Client for the IGN Geoservices API ",
  "codeRepository": "https://github.com/ahasverus/rgeoservices",
  "issueTracker": "https://github.com/ahasverus/rgeoservices/issues",
  "license": "https://spdx.org/licenses/GPL-2.0",
  "version": "0.0.0.9000",
  "programmingLanguage": {
    "@type": "ComputerLanguage",
    "name": "R",
    "url": "https://r-project.org"
  },
  "runtimePlatform": "R version 4.5.0 (2025-04-11)",
  "author": [
    {
      "@type": "Person",
      "givenName": "Nicolas",
      "familyName": "Casajus",
      "email": "rdev.nc@gmail.com",
      "@id": "https://orcid.org/0000-0002-5537-5294"
    }
  ],
  "copyrightHolder": [
    {
      "@type": "Person",
      "givenName": "Nicolas",
      "familyName": "Casajus",
      "email": "rdev.nc@gmail.com",
      "@id": "https://orcid.org/0000-0002-5537-5294"
    }
  ],
  "maintainer": [
    {
      "@type": "Person",
      "givenName": "Nicolas",
      "familyName": "Casajus",
      "email": "rdev.nc@gmail.com",
      "@id": "https://orcid.org/0000-0002-5537-5294"
    }
  ],
  "softwareSuggestions": [
    {
      "@type": "SoftwareApplication",
      "identifier": "geodata",
      "name": "geodata",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=geodata"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "ggplot2",
      "name": "ggplot2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=ggplot2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "httptest2",
      "name": "httptest2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httptest2"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "knitr",
      "name": "knitr",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=knitr"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "mapview",
      "name": "mapview",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=mapview"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "rmarkdown",
      "name": "rmarkdown",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=rmarkdown"
    },
    {
      "@type": "SoftwareApplication",
      "identifier": "testthat",
      "name": "testthat",
      "version": ">= 3.0.0",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=testthat"
    }
  ],
  "softwareRequirements": {
    "1": {
      "@type": "SoftwareApplication",
      "identifier": "R",
      "name": "R",
      "version": ">= 4.2.0"
    },
    "2": {
      "@type": "SoftwareApplication",
      "identifier": "httr2",
      "name": "httr2",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=httr2"
    },
    "3": {
      "@type": "SoftwareApplication",
      "identifier": "sf",
      "name": "sf",
      "provider": {
        "@id": "https://cran.r-project.org",
        "@type": "Organization",
        "name": "Comprehensive R Archive Network (CRAN)",
        "url": "https://cran.r-project.org"
      },
      "sameAs": "https://CRAN.R-project.org/package=sf"
    },
    "SystemRequirements": null
  },
  "fileSize": "2489.878KB",
  "citation": [
    {
      "@type": "SoftwareSourceCode",
      "datePublished": "2025",
      "author": [
        {
          "@type": "Organization",
          "name": "Casajus Nicolas"
        }
      ],
      "name": "rgeoservices: {A} {R} client for the IGN Geoservices API",
      "url": "https://github.com/ahasverus/rgeoservices",
      "description": "R package version 0.0.0.9000"
    }
  ],
  "readme": "https://github.com/ahasverus/rgeoservices/blob/main/README.md",
  "contIntegration": [
    "https://github.com/ahasverus/rgeoservices/actions/workflows/R-CMD-check.yaml",
    "https://github.com/ahasverus/rgeoservices/actions/workflows/pkgdown.yaml",
    "https://github.com/ahasverus/rgeoservices/actions/workflows/test-coverage.yaml",
    "https://codecov.io/gh/ahasverus/rgeoservices"
  ]
}

GitHub Events

Total
  • Issues event: 1
  • Delete event: 2
  • Issue comment event: 1
  • Push event: 46
  • Pull request event: 5
  • Create event: 5
Last Year
  • Issues event: 1
  • Delete event: 2
  • Issue comment event: 1
  • Push event: 46
  • Pull request event: 5
  • Create event: 5

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 1
  • Total pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 12 minutes
  • Total issue authors: 1
  • Total pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.33
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 3
Past Year
  • Issues: 1
  • Pull requests: 3
  • Average time to close issues: N/A
  • Average time to close pull requests: 12 minutes
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.33
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 3
View more stats
Top Authors
Issue Authors
  • ahasverus (1)
Pull Request Authors
  • dependabot[bot] (3)
Top Labels
Issue Labels
documentation (1)
Pull Request Labels
dependencies (3) github_actions (3)

Dependencies

.github/workflows/R-CMD-check.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/check-r-package v2 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/pkgdown.yaml actions
  • JamesIves/github-pages-deploy-action v4.4.1 composite
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/render-README.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/test-coverage.yaml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/update-citation-cff.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
.github/workflows/update-codemeta.yaml actions
  • actions/checkout v4 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite
DESCRIPTION cran
  • knitr * suggests
  • rmarkdown * suggests
  • testthat >= 3.0.0 suggests