Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/elipousson/crashapi
💥🚙💥 R package to get Fatality Analysis Reporting System (FARS) data with the FARS API
https://github.com/elipousson/crashapi
r r-package rspatial rstats
Last synced: 10 days ago
JSON representation
💥🚙💥 R package to get Fatality Analysis Reporting System (FARS) data with the FARS API
- Host: GitHub
- URL: https://github.com/elipousson/crashapi
- Owner: elipousson
- License: other
- Created: 2021-10-25T16:13:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-06T02:30:00.000Z (2 months ago)
- Last Synced: 2024-10-12T12:19:05.440Z (26 days ago)
- Topics: r, r-package, rspatial, rstats
- Language: R
- Homepage: https://elipousson.github.io/crashapi/
- Size: 6.36 MB
- Stars: 16
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.Rmd
- License: LICENSE
- Citation: CITATION.cff
Awesome Lists containing this project
README
---
output: github_document
---
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# crashapi
[](https://CRAN.R-project.org/package=crashapi)
[](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[](https://opensource.org/licenses/MIT)
[](https://app.codecov.io/gh/elipousson/crashapi?branch=main)
[](https://www.repostatus.org/#active)
The goal of the crashapi R package is to provide functions for downloading data from the National Highway Traffic Safety Administration (NHTSA) [Fatality Analysis Reporting System (FARS) API](https://crashviewer.nhtsa.dot.gov/CrashAPI/).
What is FARS? NHTSA explains: "The Fatality Analysis Reporting System (FARS) contains data on all vehicle crashes in the United States that occur on a public roadway and involve a fatality."
## Installation
You can install the development version of crashapi using the pak package:
``` r
pak::pkg_install("elipousson/crashapi")
```
## Background
### Fatality Analysis Reporting System (FARS) API support
Supported APIs for this package include:
- [x] Get Crash List Information
- [X] Get Crash Details
- [x] Get Crashes By Location
- [X] Get Crashes By Vehicle
- [x] Get Summary Counts
- [x] Get Variables and Get Variable Attributes
- [x] Get FARS Data By Year
- [X] Get Crashes By Occupant (partial support)
Most of these APIs support XML, JSV, CSV, and JSON output formats. This package only uses JSON with the exception of `get_fars_year()` (which supports downloading CSV files).
For reference, this package also includes a list of terms and NHTSA technical definitions in `fars_terms` and a list of variable labels in `fars_vars_labels`.
The FARS API currently provides access to data from 2010 to 2022. The [NHTSA website](https://www-fars.nhtsa.dot.gov/Help/helplinks.aspx) also provides additional information on the release data and version status for the FARS data files available through the API:
| Data Year | File Version | Release Date |
|-----------|--------------|-------------------|
| 2010 | Final | December 11, 2012 |
| 2011 | Final | November 13, 2013 |
| 2012 | Final | December 12, 2013 |
| 2013 | Final | December 14, 2014 |
| 2014 | Final | December 18, 2015 |
| 2015 | Final | December 16, 2016 |
| 2016 | Final | December 14, 2017 |
| 2017 | Final | December 18, 2018 |
| 2018 | Final | June 24, 2021 |
| 2019 | Final | March 2, 2022 |
| 2020 | Final | April 3, 2023 |
| 2021 | Final | August 19, 2024 |
| 2022 | Annual | August 19, 2024 |
### Additional data access functionality
The `get_fars_zip()` function can be used to access FARS data files from 1975 to 2020 that that are not available via the API but are available for download on through [the NHTSA File Downloads site](https://www.nhtsa.gov/file-downloads?p=nhtsa/downloads/FARS/) as zipped CSV or SAS files (not available through the NHTSA FARS API). This site also provides extensive technical documentation on coding and use of the FARS data files.
Earlier data along with data from the the [General Estimates System](https://www.nhtsa.gov/national-automotive-sampling-system-nass/nass-general-estimates-system) (GES) / [Crash Report Sampling System](https://www.nhtsa.gov/crash-data-systems/crash-report-sampling-system-crss) (CRSS) is also available through the [Fatality and Injury Reporting System Tool](https://cdan.dot.gov/query) (FIRST).
## Examples
```{r}
library(crashapi)
library(ggplot2)
```
Most features for the package can be accessed using the `get_fars()` function that selects the appropriate API-specific function based on the provided parameters. You can also set the API to use with the `api` parameter or use an API-specific function (e.g. `get_fars_summary()`).
For example, you can use the `get_fars()` access state-level summary data on crash and fatality counts.
```{r get_fars_summary}
# Get summary crash count and fatality count data for Maryland from 2010 to 2019
md_summary <-
get_fars(
year = c(2010, 2021),
state = "MD",
api = "summary count"
)
ggplot(md_summary, aes(x = CaseYear, y = TotalFatalCounts)) +
geom_point(color = "red") +
geom_line(color = "red", group = 1) +
theme_minimal()
```
You can download crash data and set geometry to TRUE optionally convert the data frame into an `sf` object for mapping.
```{r map_fars_crashes}
crashes_sf <-
get_fars(
year = c(2018, 2021),
state = "NC",
county = "Wake County",
geometry = TRUE
)
nc <- sf::st_read(system.file("shape/nc.shp", package = "sf"))
wake_co <- sf::st_transform(nc[nc$NAME == "Wake", ], 4326)
# Map crashes
ggplot() +
geom_sf(
data = wake_co,
fill = NA, color = "black"
) +
geom_sf(
data = sf::st_crop(crashes_sf, wake_co),
aes(color = TOTALVEHICLES),
alpha = 0.75
) +
theme_void()
```
You can list crashes and filter by the number of vehicles involved.
```{r get_fars_crash_list}
# Get fatal crashes in New York state from 2019 with 5 to 10 vehicles
get_fars(
year = 2019,
state = "NY",
vehicles = c(5, 10)
)
```
If you call `get_fars()` or `get_fars_crashes()` with details set to TRUE, additional information from `get_fars_cases()` (including the crash date and time) is appended to the crash data frame.
```{r get_fars_crashes}
# Get fatal crashes for Anne Arundel County, MD for 2019 and append details
crashes_detailed <-
get_fars(
year = 2019,
state = "MD",
county = "Anne Arundel County",
details = TRUE
)
# Show 10 fatal crashes at random
dplyr::slice_sample(crashes_detailed, n = 10)
```
## Related packages and projects
- [rfars](https://github.com/s87jackson/rfars) aims to "simplify the process of analyzing FARS data" by providing access to FARS downloads and preprocessed data back to 2015.
- [stats19](https://github.com/ropensci/stats19) "provides functions for downloading and formatting road crash data" from "the UK's official road traffic casualty database, STATS19."
- [njtr1](https://github.com/gavinrozzi/njtr1): "An R interface to New Jersey traffic crash data reported on form NJTR-1."
- [wisdotcrashdatabase](https://github.com/jacciz/wisdotcrashdatabase): "A package used for internal WisDOT crash database pulls and analysis."
- [nzcrash](https://github.com/nacnudus/nzcrash): "An R package to distribute New Zealand crash data in a convenient form."
- [GraphHopper Open Traffic Collection](https://github.com/graphhopper/open-traffic-collection): "Collections of URLs pointing to traffic information portals which contain open data or at least data which is free to use."
- [Open Crash Data Index](https://docs.google.com/spreadsheets/d/1rmn6GbHNkfWLLDEEmA87iuy2yHdh7hBybCTZiQJEY0k/edit?usp=sharing): A Google Sheet listing a range of city, county, regional and state sources for crash data including non-injury crashes as well as the fatal crashes available through the FARS API. Contributions for crash data from other U.S. cities and states are welcome.