Pull measured sensor speed data

Fetch measured speed data for a single date and sensor from the Mayfly API. Use pull_sensor_ids() to obtain metro sensor IDs.

pull_sensor_speed(
  sensor,
  pull_date,
  fill_gaps = TRUE,
  length_ft_min = NULL,
  length_ft_max = NULL,
  headway_sec_min = NULL,
  headway_sec_max = NULL,
  speed_mph_min = NULL,
  speed_mph_max = NULL,
  district = "metro",
  .quiet = TRUE
)

Arguments

sensor

character, the sensor ID. See pull_sensor_ids() to obtain metro sensor IDs.

pull_date

character, the date of data to pull. Accepts either "YYYY-MM-DD" or "YYYYMMDD" format.

fill_gaps

logical, whether to fill gaps in the time series with NA values. Default is TRUE

length_ft_min

numeric, minimum vehicle length in feet for filtering. Optional. Default is NULL.

length_ft_max

numeric, maximum vehicle length in feet for filtering (non-inclusive). Optional. Default is NULL.

headway_sec_min

numeric, minimum headway in seconds for filtering. Optional. Default is NULL.

headway_sec_max

numeric, maximum headway in seconds for filtering (non-inclusive). Optional. Default is NULL.

speed_mph_min

numeric, minimum speed in mph for filtering. Optional. Default is NULL.

speed_mph_max

numeric, maximum speed in mph for filtering (non-inclusive). Optional. Default is NULL.

district

character, MnDOT district code. Default is "metro". Use mayfly_get_districts() to see available districts.

.quiet

logical, whether to suppress error messages. Default TRUE

Value

data.table containing variables speed, sensor, date, hour, min.

Details

Filtering

The filtering parameters allow filtering of vehicle observations based on
measured speed, vehicle length, and headway. This can be useful for traffic
analysis, identifying speeding, or filtering unrealistic measurements.

See also

Other loop sensor functions: pull_configuration(), pull_sensor(), pull_sensor_espeed(), pull_sensor_headway(), pull_sensor_ids(), pull_sensor_length()

Examples

if (FALSE) { # \dontrun{
library(tc.sensors)
# Simple example
speed_data <- pull_sensor_speed(5474, "2025-10-14")

# Passenger cars traveling at highway speeds
highway_cars <- pull_sensor_speed(5474, "2025-10-14",
  speed_mph_min = 55,
  speed_mph_max = 75,
  length_ft_min = 10,
  length_ft_max = 20
)
} # }