nflreadr 
nflreadr is a minimal package for downloading data from nflverse repositories. It includes caching, optional progress updates, and data dictionaries.
Please note that nflverse data repositories have been reorganized and pushed towards the nflverse-data repo, and v1.2.0+ is the minimum version that supports this change. We encourage all users to upgrade to this version immediately.
For Python access to nflverse data, please check out nfl-data-py - maintained by Cooper Adams.
Installation
Install the stable version from CRAN with:
install.packages("nflreadr")Install the development version from GitHub with:
install.packages("nflreadr", repos = c("https://nflverse.r-universe.dev", getOption("repos")))
# or use remotes/devtools
# install.packages("remotes")
remotes::install_github("nflverse/nflreadr")Usage
The main functions of nflreadr are prefixed with load_.
library(nflreadr)
load_pbp(2021)
#> ── nflverse play by play data ──────────────────────────────────────────────────
#> ℹ Data updated: 2022-09-27 07:35:02 EDT
#> # A tibble: 50,712 × 372
#> play_id game_id old_g…¹ home_…² away_…³ seaso…⁴ week posteam poste…⁵ defteam
#> <dbl> <chr> <chr> <chr> <chr> <chr> <int> <chr> <chr> <chr>
#> 1 1 2021_0… 202109… TEN ARI REG 1 <NA> <NA> <NA>
#> 2 40 2021_0… 202109… TEN ARI REG 1 TEN home ARI
#> 3 55 2021_0… 202109… TEN ARI REG 1 TEN home ARI
#> 4 76 2021_0… 202109… TEN ARI REG 1 TEN home ARI
#> 5 100 2021_0… 202109… TEN ARI REG 1 TEN home ARI
#> 6 122 2021_0… 202109… TEN ARI REG 1 TEN home ARI
#> 7 152 2021_0… 202109… TEN ARI REG 1 ARI away TEN
#> 8 181 2021_0… 202109… TEN ARI REG 1 ARI away TEN
#> 9 218 2021_0… 202109… TEN ARI REG 1 ARI away TEN
#> 10 253 2021_0… 202109… TEN ARI REG 1 ARI away TEN
#> # … with 50,702 more rows, 362 more variables: side_of_field <chr>,
#> # yardline_100 <dbl>, game_date <chr>, quarter_seconds_remaining <dbl>,
#> # half_seconds_remaining <dbl>, game_seconds_remaining <dbl>,
#> # game_half <chr>, quarter_end <dbl>, drive <dbl>, sp <dbl>, …, and
#> # abbreviated variable names ¹old_game_id, ²home_team, ³away_team,
#> # ⁴season_type, ⁵posteam_type
#> # ℹ Use `print(n = ...)` to see more rows, and `colnames()` to see all variable names
load_player_stats(2021)
#> ── nflverse player stats: offense ──────────────────────────────────────────────
#> ℹ Data updated: 2023-01-05 04:08:21 EST
#> # A tibble: 5,698 × 52
#> player…¹ playe…² playe…³ posit…⁴ posit…⁵ heads…⁶ recen…⁷ season week seaso…⁸
#> <chr> <chr> <chr> <chr> <chr> <chr> <chr> <int> <int> <chr>
#> 1 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 1 REG
#> 2 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 2 REG
#> 3 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 3 REG
#> 4 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 4 REG
#> 5 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 5 REG
#> 6 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 6 REG
#> 7 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 7 REG
#> 8 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 8 REG
#> 9 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 10 REG
#> 10 00-0019… T.Brady Tom Br… QB QB https:… TB 2021 11 REG
#> # … with 5,688 more rows, 42 more variables: completions <int>, attempts <int>,
#> # passing_yards <dbl>, passing_tds <int>, interceptions <dbl>, sacks <dbl>,
#> # sack_yards <dbl>, sack_fumbles <int>, sack_fumbles_lost <int>,
#> # passing_air_yards <dbl>, …, and abbreviated variable names ¹player_id,
#> # ²player_name, ³player_display_name, ⁴position, ⁵position_group,
#> # ⁶headshot_url, ⁷recent_team, ⁸season_type
#> # ℹ Use `print(n = ...)` to see more rows, and `colnames()` to see all variable namesData Sources
Data accessed by this package is stored on GitHub and can typically be found in one of the following repositories:
- nflverse/nflverse-data
- nflverse/nfldata
- nflverse/espnscrapeR-data
- dynastyprocess/data
- ffverse/ffopportunity
For a full list of functions, please see the reference page.
This data is maintained by the nflverse project team and is primarily automated via GitHub Actions. You can check the status and schedules page here: https://github.com/nflverse/nflverse-data
Configuration
The following options help configure default nflreadr behaviours.
options(nflreadr.verbose)
# TRUE/FALSE to silence messages such as cache warnings
options(nflreadr.cache)
# one of "memory", "filesystem", or "off"
options(nflreadr.prefer)
# one of "qs", "rds", "parquet", or "csv"
options(nflreadr.download_path)
# defaults to current working directory - change to specify where `nflverse_download()` places data.You can also configure nflreadr to display progress messages with the
progressr package, e.g.
progressr::with_progress(load_rosters(seasons = 2010:2020))
|======== | 40%Getting help
The best places to get help on this package are:
- the nflverse discord (for both this package as well as anything R/NFL related)
- opening an issue
Contributing
Many hands make light work! Here are some ways you can contribute to this project:
-
You can open an issue if you’d like to request specific data or report a bug/error.
-
If you’d like to contribute code, please check out the contribution guidelines.
Terms of Use
The R code for this package is released as open source under the MIT License. NFL data accessed by this package belong to their respective owners, and are governed by their terms of use.