flow: HERE Traffic API: Flow

View source: R/flow.R

flowR Documentation

HERE Traffic API: Flow

Description

Real-time traffic flow from the HERE 'Traffic' API in areas of interest (AOIs). The traffic flow data contains speed and congestion information, which corresponds to the status of the traffic at the time of the query.

Usage

flow(aoi, min_jam_factor = 0, url_only = FALSE)

Arguments

aoi

sf object, Areas of Interest (POIs) of geometry type POLYGON.

min_jam_factor

numeric, only retrieve flow information with a jam factor greater than the value provided (default = 0).

url_only

boolean, only return the generated URLs (default = FALSE)?

Value

An sf object containing the requested traffic flow information.

Note

The maximum width and height of the bounding box of the input AOIs is 1 degree. This means that each polygon (= one row) in the AOI sf object should fit in a 1 x 1 degree bbox.

References

HERE Traffic API: Flow

Examples

# Provide an API Key for a HERE project
set_key("<YOUR API KEY>")

# Real-time traffic flow
flow_data <- flow(
  aoi = aoi,
  url_only = TRUE
)

hereR documentation built on Sept. 18, 2023, 5:21 p.m.