-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
57 lines (41 loc) · 3.68 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
---
output: github_document
---
```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = TRUE, eval = FALSE)
```
# tc.sensors
<!-- badges: start -->
[](https://github.com/Metropolitan-Council/tc.sensors/actions)
[](https://www.tidyverse.org/lifecycle/#maturing)
[](http://data.dot.state.mn.us/trafdat/metro/2018/20181021/5474.c30.json)
[](http://mesonet.agron.iastate.edu/request/download.phtml?network=MN_ASOS)
<!-- badges: end -->
# tc.sensors <img src="man/figures/logo.png" align="right" height="300" />
## Overview
A package for pulling data for Minnesota Department of Transportation (MnDOT) loop detectors installed on the Minnesota Freeway system in 30-second interval measurements of occupancy and volume, data which are pushed daily to a public JSON feed.
## Installation
```{r}
remotes::install_github("Metropolitan-Council/tc.sensors")
```
## Documentation
To access documentation and for help on how to use the package, run `?<FUNCTION-NAME>` (e.g. `?pull_sensor`, `?pull_configuration`, `?pull_sensor_ids`). Access vignettes in the vignettes file to see examples of end-to-end workflows for pulling and storing data locally en masse. Check back for a vignettes for calculating speeds, reference speeds, delay, and VMT from the resulting files.
## Relevant definitions
Definitions come from MnDOT Data Extract [documentation](http://data.dot.state.mn.us/datatools/dataextract.html)
- **Volume** The number of vehicles that pass through a detector in a given time period.
- **Occupancy** The percentage of time a detector's field is occupied by a vehicle.
- **Flow** The number of vehicles that pass through a detector per hour (`Volume * Samples per Hour`).
- **Headway** The number of seconds between each vehicle (`Seconds_per_Hour / Flow`).
- **Density** The number of vehicles per mile (`Flow / Speed`). See [full calculation method](http://data.dot.state.mn.us/datatools/Density.html) for additional context.
- **Speed** The average speed of the vehicles that pass in a sampling period (`Flow / Density`).
- **Lost/Spare Capacity** The average flow that a roadway is losing, either due to low traffic or high congestion, throughout the sampling period.
- `Flow > 1800: 0`
- `Density > 43: Lost Capacity: Flow - 1800`
- `Density >= 43: Lost Capacity: 1800 - Flow`
## Associated repositories and projects
- **[loop-sensor-trends](https://github.com/Metropolitan-Council/loop-sensor-trends)** Data analysis and interactive R Shiny app for examining changes in regional traffic levels in response to the COVID-19 pandemic.
- **[Twin-Cities-Loop-Detectors](https://github.com/sullivannicole/Twin-Cities-Loop-Detectors)** A pre-cursor to `{tc.sensors}`. Contains extensive documentation and code samples that will be integrated into this package.
## Contributors
**Maintainer** Liz Roten ([email protected])
[@ashleyasmus](https://github.com/ashleyasmus), [@eroten](https://github.com/eroten), and [@sullivannicole](https://github.com/sullivannicole).
<a href="https://metrocouncil.org" target="_blank"><img src="man/figures/main-logo.png" style="margin-left: 50%;margin-right: 50%;"><div></div></a>