Data

Tools

Indexes

Applications

Experiments

Open Source Science

herer

R package that provides an interface to the HERE REST APIs: Geocoder API, Routing API, Traffic API, Public Transit API and Destination Weather API. Locations and routes are returned as 'sf' objects.

https://github.com/munterfi/herer

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 (16.7%) to scientific vocabulary

Keywords

api geocoding gis here-technologies isoline routing rspatial rstats traffic weather
Last synced: 6 months ago · JSON representation

Repository

R package that provides an interface to the HERE REST APIs: Geocoder API, Routing API, Traffic API, Public Transit API and Destination Weather API. Locations and routes are returned as 'sf' objects.

Basic Info
Statistics
  • Stars: 91
  • Watchers: 3
  • Forks: 11
  • Open Issues: 2
  • Releases: 24
Topics
api geocoding gis here-technologies isoline routing rspatial rstats traffic weather
Created over 6 years ago · Last pushed 12 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct

README.md

hereR

CRAN status CRAN checks CRAN downloads R-CMD-check Codecov test coverage CodeFactor

The hereR package provides an interface to the HERE REST APIs for R: (1) geocode and autosuggest addresses or reverse geocode POIs using the Geocoder API; (2) route directions, travel distance or time matrices and isolines using the Routing API, Matrix Routing API and Isoline Routing API; (3) request real-time traffic flow and incident information from the Traffic API; (4) find public transport connections and nearby stations using the Public Transit API; (5) request intermodal routes using the Intermodal Routing API; (6) get weather forecasts, reports on current weather conditions and astronomical information at a specific location from the Destination Weather API.

Locations, routes and isolines are returned as sf objects.

Installation

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

r install.packages("hereR")

Install the development version from GitHub with:

r remotes::install_github("munterfi/hereR")

Usage

This package requires an API key for a HERE project. The key is set for the current R session and is used to authenticate in the requests to the APIs. A login can be created on developer.here.com. In order to obtain the API key navigate to a project of your choice in the developer portal, select 'REST: Generate APP' and then 'Create API Key'.

To set the API key, use:

r library(hereR) set_key("<YOUR API KEY>")

Note: Your use of the HERE APIs with this package is subject to the HERE Developer Terms and Conditions. For freemium licenses the number of requests per second (RPS) is limited, use set_freemium(FALSE) to turn off limits for accounts with paid plans.

Once valid application credentials are created and the key is set in the R session, the APIs can be addressed using the functions shown in the examples below. A more detailed description can be found in the documentation of the functions and the package vignettes.

Geocoding & Search API: Autosuggest and geocode addresses or reverse geocode POIs.

```r geocode(c("Schweighofstrasse 190, Zurich, Switzerland", "Hardstrasse 48, Zurich, Switzerland"))

autosuggest(c("Schweighofstrasse", "Hardstrasse"))

reverse_geocode(poi) ```

Routing API: Construct route geometries with elevation (dim = XYZ).

```r route(poi[1:2, ], poi[3:4, ], transport_mode = "car", traffic = TRUE)

route(poi[1:2, ], poi[3:4, ], transport_mode = "car", traffic = FALSE)

route(poi[4, ], poi[5, ], transport_mode = "bicycle") ```

Matrix Routing API: Request a matrix of route summaries.

```r routematrix(poi, transportmode = "car", traffic = TRUE)

routematrix( geocode(c("Schweighofstrasse 190, Zurich, Switzerland", "Hardstrasse 48, Zurich, Switzerland")), transportmode = "bicycle", traffic = FALSE ) ```

Isoline Routing API: Construct isolines around points (time, distance or consumption).

```r isoline(poi, rangetype = "time", transportmode = "pedestrian")

isoline(poi, rangetype = "distance", transportmode = "truck")

isoline(poi, rangetype = "consumption", transportmode = "car", traffic = FALSE) ```

Traffic API: Get real-time traffic flow or incidents in a specific area.

```r flow(aoi)

incident(aoi) ```

Public Transit API: Request public transport connections between points or find stations nearby.

```r connection(poi[1:2, ], poi[3:4, ])

station(poi, radius = 500) ```

Intermodal Routing API: Get routes with various combinations of transport modes.

r intermodal_route(poi[1:2, ], poi[3:4, ])

Destination Weather API: Request weather observations, forecasts, astronomical information or alerts at specific locations.

```r weather(poi, product = "observation")

weather(poi, product = "forecast_hourly")

weather(poi, product = "forecast_astronomy")

weather(poi, product = "alerts") ```

Contributing

  • Contributions to this package are very welcome, issues and pull requests are the preferred ways to share them. Please see the Contribution Guidelines.
  • This project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

References

Owner

  • Name: Merlin Unterfinger
  • Login: munterfi
  • Kind: user
  • Location: Zurich, Switzerland
  • Company: SBB (Swiss Federal Railways)

Data Scientist at the Swiss Federal Railways (SBB), specialized in Geographic Information Science.

GitHub Events

Total
  • Create event: 11
  • Release event: 2
  • Issues event: 10
  • Watch event: 3
  • Delete event: 8
  • Issue comment event: 12
  • Push event: 26
  • Pull request event: 13
Last Year
  • Create event: 11
  • Release event: 2
  • Issues event: 10
  • Watch event: 3
  • Delete event: 8
  • Issue comment event: 12
  • Push event: 26
  • Pull request event: 13

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 538
  • Total Committers: 7
  • Avg Commits per committer: 76.857
  • Development Distribution Score (DDS): 0.026
Past Year
  • Commits: 18
  • Committers: 1
  • Avg Commits per committer: 18.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Merlin Unterfinger i****o@m****h 524
Daniel Possenriede p****e@g****m 5
Ildi Szabo s****e@g****m 4
Balthasar b****r@g****m 2
panhypersebastos p****s@g****m 1
TomJaksztat 6****t 1
Daniel Possenriede p****e@a****e 1
Committer Domains (Top 20 + Academic)
analyse-konzepte.de: 1 munterfinger.ch: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 43
  • Total pull requests: 80
  • Average time to close issues: 18 days
  • Average time to close pull requests: about 10 hours
  • Total issue authors: 25
  • Total pull request authors: 6
  • Average comments per issue: 2.37
  • Average comments per pull request: 0.13
  • Merged pull requests: 77
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 5
  • Pull requests: 9
  • Average time to close issues: 16 days
  • Average time to close pull requests: about 2 hours
  • Issue authors: 5
  • Pull request authors: 1
  • Average comments per issue: 2.2
  • Average comments per pull request: 0.33
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • munterfi (12)
  • nbanion (3)
  • hrecht (3)
  • isaid-hi (2)
  • kaijagahm (2)
  • dpprdan (2)
  • cris-silva (1)
  • arielfuentes (1)
  • spatialhusky (1)
  • AlexandraKapp (1)
  • enriquevaa (1)
  • cpaez1990 (1)
  • xiongnemo (1)
  • hadley (1)
  • technocrat (1)
Pull Request Authors
  • munterfi (79)
  • gregleleu (2)
  • panhypersebastos (1)
  • balthasars (1)
  • szaboildi (1)
  • dpprdan (1)
Top Labels
Issue Labels
bug (25) feature (11) enhancement (5) duplicate (3) wontfix (2) dependencies (1)
Pull Request Labels
bug (13) enhancement (10) feature (10) release (7) documentation (4)

Packages

  • Total packages: 1
  • Total downloads:
    • cran 1,076 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 24
  • Total maintainers: 1
cran.r-project.org: hereR

'sf'-Based Interface to the 'HERE' REST APIs

  • Versions: 24
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 1,076 Last month
Rankings
Stargazers count: 4.6%
Forks count: 7.3%
Average: 17.1%
Downloads: 21.0%
Dependent repos count: 23.9%
Dependent packages count: 28.7%
Maintainers (1)
info@munterfinger.ch
Last synced: 6 months ago

Dependencies

DESCRIPTION cran
  • R >= 3.3.0 depends
  • crul >= 1.1.0 imports
  • curl >= 4.3 imports
  • data.table >= 1.13.0 imports
  • flexpolyline >= 0.2.0 imports
  • jsonlite >= 1.7.0 imports
  • sf >= 0.9 imports
  • stringr >= 1.4.0 imports
  • covr >= 3.5.0 suggests
  • ggplot2 >= 3.3.2 suggests
  • htmlwidgets >= 1.5.1 suggests
  • knitr >= 1.29 suggests
  • leafpop >= 0.0.5 suggests
  • lwgeom >= 0.2 suggests
  • mapview >= 2.9.0 suggests
  • rmarkdown >= 2.3 suggests
  • testthat >= 2.3.2 suggests
.github/workflows/pkgdown.yaml actions
  • actions/cache v1 composite
  • actions/checkout v3 composite
  • r-lib/actions/setup-pandoc v2 composite
  • r-lib/actions/setup-r v2 composite
.github/workflows/check-standard.yaml actions
  • actions/checkout v3 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/test-coverage.yaml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • r-lib/actions/setup-r v2 composite
  • r-lib/actions/setup-r-dependencies v2 composite