Skip to content

Commit

Permalink
docs: add citation.cff, codemeta.json, add badges in README
Browse files Browse the repository at this point in the history
  • Loading branch information
rCarto committed May 31, 2022
1 parent 728fb31 commit 625ebea
Show file tree
Hide file tree
Showing 9 changed files with 445 additions and 22 deletions.
4 changes: 3 additions & 1 deletion .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@
^data-raw$
^img$
^\.github$
^README\.Rmd$
^README\.Rmd$
^CITATION\.cff$
^codemeta\.json$
220 changes: 220 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,220 @@
# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.2.2
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------

cff-version: 1.2.0
message: 'To cite package "osrm" in publications use:'
type: software
license: GPL-3.0-only
title: 'osrm: Interface Between R and the OpenStreetMap-Based Routing Service OSRM'
version: 4.0.0
abstract: An interface between R and the 'OSRM' API. 'OSRM' is a routing service based
on 'OpenStreetMap' data. See <http://project-osrm.org/> for more information. This
package allows to compute routes, trips, isochrones and travel distances matrices
(travel time and kilometric distance).
authors:
- family-names: Giraud
given-names: Timothée
email: timothee.giraud@cnrs.fr
orcid: https://orcid.org/0000-0002-1932-3323
preferred-citation:
type: manual
title: 'osrm: Interface Between R and the OpenStreetMap-Based Routing Service OSRM'
authors:
- family-names: Giraud
given-names: Timothée
email: timothee.giraud@cnrs.fr
orcid: https://orcid.org/0000-0002-1932-3323
version: 4.0.0
abstract: An interface between R and the 'OSRM' API. 'OSRM' is a routing service
based on 'OpenStreetMap' data. See <http://project-osrm.org/> for more information.
This package allows to compute routes, trips, isochrones and travel distances
matrices (travel time and kilometric distance).
repository: https://CRAN.R-project.org/package=osrm
repository-code: https://github.com/riatelab/osrm
url: https://github.com/riatelab/osrm
contact:
- family-names: Giraud
given-names: Timothée
email: timothee.giraud@cnrs.fr
orcid: https://orcid.org/0000-0002-1932-3323
keywords:
- cran
- openstreetmap
- osrm
- r
- r-package
- shortest-paths
- travel
license: GPL-3.0-only
year: '2022'
repository: https://CRAN.R-project.org/package=osrm
repository-code: https://github.com/riatelab/osrm
url: https://github.com/riatelab/osrm
contact:
- family-names: Giraud
given-names: Timothée
email: timothee.giraud@cnrs.fr
orcid: https://orcid.org/0000-0002-1932-3323
keywords:
- cran
- openstreetmap
- osrm
- r
- r-package
- shortest-paths
- travel
references:
- type: software
title: RcppSimdJson
abstract: 'RcppSimdJson: ''Rcpp'' Bindings for the ''simdjson'' Header-Only Library
for ''JSON'' Parsing'
notes: Imports
authors:
- family-names: Eddelbuettel
given-names: Dirk
- family-names: Knapp
given-names: Brendan
- family-names: Lemire
given-names: Daniel
year: '2022'
url: https://CRAN.R-project.org/package=RcppSimdJson
- type: software
title: curl
abstract: 'curl: A Modern and Flexible Web Client for R'
notes: Imports
authors:
- family-names: Ooms
given-names: Jeroen
email: jeroen@berkeley.edu
orcid: https://orcid.org/0000-0002-4035-0289
year: '2022'
url: https://CRAN.R-project.org/package=curl
- type: software
title: utils
abstract: 'R: A Language and Environment for Statistical Computing'
notes: Imports
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2022'
url: https://www.R-project.org/
institution:
name: R Foundation for Statistical Computing
- type: software
title: isoband
abstract: 'isoband: Generate Isolines and Isobands from Regularly Spaced Elevation
Grids'
notes: Imports
authors:
- family-names: Wilke
given-names: Claus O.
email: wilke@austin.utexas.edu
orcid: https://orcid.org/0000-0002-7470-9261
- family-names: Pedersen
given-names: Thomas Lin
email: thomasp85@gmail.com
orcid: https://orcid.org/0000-0002-5147-4711
year: '2022'
url: https://CRAN.R-project.org/package=isoband
- type: software
title: methods
abstract: 'R: A Language and Environment for Statistical Computing'
notes: Imports
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2022'
url: https://www.R-project.org/
institution:
name: R Foundation for Statistical Computing
- type: software
title: googlePolylines
abstract: 'googlePolylines: Encoding Coordinates into ''Google'' Polylines'
notes: Imports
authors:
- family-names: Cooley
given-names: David
email: dcooley@symbolix.com.au
year: '2022'
url: https://CRAN.R-project.org/package=googlePolylines
- type: software
title: sf
abstract: 'sf: Simple Features for R'
notes: Imports
authors:
- family-names: Pebesma
given-names: Edzer
email: edzer.pebesma@uni-muenster.de
orcid: https://orcid.org/0000-0001-8049-7069
year: '2022'
url: https://CRAN.R-project.org/package=sf
- type: software
title: 'R: A Language and Environment for Statistical Computing'
notes: Depends
authors:
- name: R Core Team
location:
name: Vienna, Austria
year: '2022'
url: https://www.R-project.org/
institution:
name: R Foundation for Statistical Computing
version: '>= 3.5.0'
- type: software
title: mapsf
abstract: 'mapsf: Thematic Cartography'
notes: Suggests
authors:
- family-names: Giraud
given-names: Timothée
email: timothee.giraud@cnrs.fr
orcid: https://orcid.org/0000-0002-1932-3323
year: '2022'
url: https://CRAN.R-project.org/package=mapsf
- type: software
title: lwgeom
abstract: 'lwgeom: Bindings to Selected ''liblwgeom'' Functions for Simple Features'
notes: Suggests
authors:
- family-names: Pebesma
given-names: Edzer
email: edzer.pebesma@uni-muenster.de
orcid: https://orcid.org/0000-0001-8049-7069
year: '2022'
url: https://CRAN.R-project.org/package=lwgeom
- type: software
title: tinytest
abstract: 'tinytest: Lightweight and Feature Complete Unit Testing Framework'
notes: Suggests
authors:
- family-names: van der Loo
given-names: Mark
email: mark.vanderloo@gmail.com
orcid: https://orcid.org/0000-0002-9807-4686
year: '2022'
url: https://CRAN.R-project.org/package=tinytest
- type: software
title: covr
abstract: 'covr: Test Coverage for Packages'
notes: Suggests
authors:
- family-names: Hester
given-names: Jim
email: james.f.hester@gmail.com
year: '2022'
url: https://CRAN.R-project.org/package=covr
- type: software
title: maptiles
abstract: 'maptiles: Download and Display Map Tiles'
notes: Suggests
authors:
- family-names: Giraud
given-names: Timothée
email: timothee.giraud@cnrs.fr
orcid: https://orcid.org/0000-0002-1932-3323
year: '2022'
url: https://CRAN.R-project.org/package=maptiles
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Package: osrm
Type: Package
Title: Interface Between R and the OpenStreetMap-Based Routing Service OSRM
Version: 4.0.0.0
Version: 4.0.0
Authors@R: c(person("Timothée", "Giraud", email = "timothee.giraud@cnrs.fr",
role = c("cre","aut"), comment = c(ORCID = "0000-0002-1932-3323")),
person("Robin", "Cura", role = c("ctb")),
Expand Down
10 changes: 4 additions & 6 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ output: github_document

# osrm <img src="man/figures/logo.png" align="right" width="140"/>

[![Version](http://www.r-pkg.org/badges/version/osrm)](https://CRAN.R-project.org/package=osrm/)
![](http://cranlogs.r-pkg.org/badges/osrm?color=brightgreen)
[![CRAN](https://www.r-pkg.org/badges/version/osrm)](https://cran.r-project.org/package=osrm)
[![downloads](https://cranlogs.r-pkg.org/badges/osrm?color=brightgreen)](https://cran.r-project.org/package=osrm)
[![R build status](https://github.com/riatelab/osrm/workflows/R-CMD-check/badge.svg)](https://github.com/riatelab/osrm/actions)
<!-- [![codecov](https://codecov.io/gh/riatelab/osrm/branch/master/graph/badge.svg?token=JOJNuBCH9M)](https://codecov.io/gh/riatelab/osrm) -->

[![codecov](https://codecov.io/gh/riatelab/osrm/branch/master/graph/badge.svg?token=JOJNuBCH9M)](https://app.codecov.io/gh/riatelab/osrm)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)



Expand Down Expand Up @@ -66,8 +66,6 @@ apotheke.sf <- st_read(system.file("gpkg/apotheke.gpkg", package = "osrm"),
quiet = TRUE)
# Travel time matrix
distA <- osrmTable(loc = apotheke.sf[1:5,])
distA$durations
```

<small>
Expand Down
24 changes: 10 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@

# osrm <img src="man/figures/logo.png" align="right" width="140"/>

[![Version](http://www.r-pkg.org/badges/version/osrm)](https://CRAN.R-project.org/package=osrm/)
![](http://cranlogs.r-pkg.org/badges/osrm?color=brightgreen) [![R build
[![CRAN](https://www.r-pkg.org/badges/version/osrm)](https://cran.r-project.org/package=osrm)
[![downloads](https://cranlogs.r-pkg.org/badges/osrm?color=brightgreen)](https://cran.r-project.org/package=osrm)
[![R build
status](https://github.com/riatelab/osrm/workflows/R-CMD-check/badge.svg)](https://github.com/riatelab/osrm/actions)
<!-- [![codecov](https://codecov.io/gh/riatelab/osrm/branch/master/graph/badge.svg?token=JOJNuBCH9M)](https://codecov.io/gh/riatelab/osrm) -->
[![codecov](https://codecov.io/gh/riatelab/osrm/branch/master/graph/badge.svg?token=JOJNuBCH9M)](https://app.codecov.io/gh/riatelab/osrm)
[![Project Status: Active – The project has reached a stable, usable
state and is being actively
developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)

***Interface Between R and the OpenStreetMap-Based Routing Service
[OSRM](http://project-osrm.org/)***
Expand Down Expand Up @@ -60,30 +64,22 @@ library(osrm)
library(sf)
```

## Linking to GEOS 3.9.0, GDAL 3.2.2, PROJ 7.1.0; sf_use_s2() is TRUE
## Linking to GEOS 3.9.0, GDAL 3.2.2, PROJ 7.2.1; sf_use_s2() is TRUE

``` r
apotheke.sf <- st_read(system.file("gpkg/apotheke.gpkg", package = "osrm"),
quiet = TRUE)
# Travel time matrix
distA <- osrmTable(loc = apotheke.sf[1:5,])
distA$durations
```

## 1 2 3 4 5
## 1 0.0 21.1 33.2 21.2 12.6
## 2 22.1 0.0 42.3 16.1 20.2
## 3 32.7 43.0 0.0 30.5 27.4
## 4 20.1 15.3 29.7 0.0 12.7
## 5 10.2 20.3 26.8 12.3 0.0

<small>

| | 1 | 2 | 3 | 4 | 5 |
|:----|-----:|-----:|-----:|-----:|-----:|
| 1 | 0.0 | 21.1 | 33.2 | 21.2 | 12.6 |
| 1 | 0.0 | 21.1 | 33.4 | 21.2 | 12.6 |
| 2 | 22.1 | 0.0 | 42.3 | 16.1 | 20.2 |
| 3 | 32.7 | 43.0 | 0.0 | 30.5 | 27.4 |
| 3 | 33.0 | 43.0 | 0.0 | 30.5 | 27.4 |
| 4 | 20.1 | 15.3 | 29.7 | 0.0 | 12.7 |
| 5 | 10.2 | 20.3 | 26.8 | 12.3 | 0.0 |

Expand Down
Loading

0 comments on commit 625ebea

Please sign in to comment.