Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nflverse/nflreadr
Efficiently download nflverse data
https://github.com/nflverse/nflreadr
cran nfl nflfastr nflverse r r-package sports-data
Last synced: 8 days ago
JSON representation
Efficiently download nflverse data
- Host: GitHub
- URL: https://github.com/nflverse/nflreadr
- Owner: nflverse
- License: other
- Created: 2021-07-10T15:03:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-03T11:13:44.000Z (about 1 month ago)
- Last Synced: 2024-10-29T08:31:51.407Z (9 days ago)
- Topics: cran, nfl, nflfastr, nflverse, r, r-package, sports-data
- Language: R
- Homepage: https://nflreadr.nflverse.com/
- Size: 60.4 MB
- Stars: 60
- Watchers: 4
- Forks: 13
- Open Issues: 11
-
Metadata Files:
- Readme: README.Rmd
- Changelog: NEWS.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
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%"
)
library(tibble)
options(tibble.max_extra_cols = 10,
tibble.bold = TRUE,
tibble.print_max = 5,
pillar.min_title_width = 5)
```
# nflreadr 
[](https://CRAN.R-project.org/package=nflreadr)
[](https://app.codecov.io/gh/nflverse/nflreadr?branch=main)
[](https://nflreadr.nflverse.com/)
[](https://lifecycle.r-lib.org/articles/stages.html)
[](https://github.com/nflverse/nflreadr/actions)
[](https://discord.com/invite/5Er2FBnnQa)
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](https://github.com/nflverse/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](https://pypi.org/project/nfl-data-py/) - maintained by Cooper Adams.
## Installation
Install the stable version from CRAN with:
```{r eval = FALSE}
install.packages("nflreadr")
```
Install the development version from GitHub with:
```{r eval = FALSE}
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_`.
```{r}
library(nflreadr)
load_pbp(2021)
load_player_stats(2021)
```
## Data Sources
Data accessed by this package is stored on GitHub and can typically be found in one of the following repositories:
- [nflverse/nflverse-data](https://github.com/nflverse/nflverse-data)
- [nflverse/nfldata](https://github.com/nflverse/nfldata)
- [nflverse/espnscrapeR-data](https://github.com/nflverse/espnscrapeR-data)
- [dynastyprocess/data](https://github.com/dynastyprocess/data)
- [ffverse/ffopportunity](https://github.com/ffverse/ffopportunity)
For a full list of functions, please see the [reference page](https://nflreadr.nflverse.com/reference/index.html).
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:
## Configuration
The following options help configure default `nflreadr` behaviours.
```{r eval = FALSE}
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](https://progressr.futureverse.org), e.g.
```{r eval = FALSE}
progressr::with_progress(load_rosters(seasons = 2010:2020))
|======== | 40%
```
## Getting help
The best places to get help on this package are:
- the [nflverse discord](https://discord.com/invite/5Er2FBnnQa) (for both this package as well as anything R/NFL related)
- opening [an issue](https://github.com/nflverse/nflreadr/issues/new/choose)
## Contributing
Many hands make light work! Here are some ways you can contribute to
this project:
- You can [open an issue](https://github.com/nflverse/nflreadr/issues/new/choose) 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](https://nflreadr.nflverse.com/CONTRIBUTING.html).
## Terms of Use
The R code for this package is released as open source under the [MIT License](https://nflreadr.nflverse.com/LICENSE.html). NFL data accessed by this package belong to their respective owners, and are governed by their terms of use.