README.md

In tlorusso/traveltimeR: a Traveltime API Wrapper for R

traveltime - a Traveltime API Wrapper for R

The traveltime-package allows to retrieve isochrones for traveltime-maps from the Traveltime Platform API directly from R. The isochrones are stored as sf-objects, ready for visualization or further processing. The isochrones display how far you can travel from a certain location within a given timeframe. Numerous modes of transport are supported.

GET an API-KEY here: http://docs.traveltimeplatform.com/overview/getting-keys/

For non-commercial use the usage of the API is free for a restricted period of 10 days and can be granted for longer periods upon request.

You can install the traveltime-package with devtools or remotes from Github.

devtools::install_github("tlorusso/traveltime")

library(traveltime)

The traveltime_map function allows to easily retrieve traveltime-isochrones via the Traveltime-API.

querying the Traveltime-API with traveltime_map

# retrieve isochrones via request 

The following transport modes are supported:

# "cycling"", "cycling_ferry", "driving", "driving+train", "driving_ferry", "public_transport", 
# "walking", "walking+coach", "walking_bus", "walking_ferry" or "walking_train".


# how far can you go by public transport within 30 minutes?

traveltime30 <- traveltime_map(appId="YourAppId",
               apiKey="YourAPIKey",
               location=c(47.378610,8.54000),
               traveltime=1800,
               type="public_transport",
               departure="YYYY-MM-DDT08:00:00Z")

# take a glimpse at the data

plot(traveltime30)

# or on top of a leaflet-map with mapview

mapview::mapview(traveltime30)

# You can switch to arrival search (from how far is a location reachable within x min?) just by using the 'arrival' argument instead of 'departure'.

traveltime30_arrival <- traveltime_map(appId="YourAppId",
               apiKey="YourAPIKey",
               location=c(47.378610,8.54000),
               traveltime=1800,
               type="public_transport",
               arrival="YYYY-MM-DDT08:00:00Z")

Some examples of how to use the API-Wrapper and what can be done with the data are available here:

https://www.tlorusso.ch/posts/traveltime/

In the upcoming version, further API-Modules will be supported.

tlorusso/traveltimeR documentation built on March 3, 2021, 10:19 a.m.