README.md

In nflverse: Easily Install and Load the 'nflverse'

nflverse

Overview

The nflverse is a set of packages dedicated to data of the National Football League. The nflverse package is designed to make it easy to install and load core packages from the nflverse in a single command. Please see the nflverse organisation repo on more information about governance, the code of conduct and possible roles.

Installation

The easiest way to get nflverse is to install it from CRAN with:

install.packages("nflverse")

To get a bug fix or to use a feature from the development version, you can install the development version of nflverse either from GitHub with:

if (!require("pak")) install.packages("pak")
pak::pak("nflverse/nflverse")

or prebuilt from the development repo with:

install.packages("nflverse", repos = c("https://nflverse.r-universe.dev", getOption("repos")))

Usage

library(nflverse) will load the following nflverse packages:

• nflfastR, for play-by-play data back to 1999.
• nflseedR, for season simulations.
• nfl4th, for 4th down analysis.
• nflreadr, for fast end efficient nflverse data downloads.
• nflplotR, for tools to create visualization of NFL related analysis.

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.

nflverse documentation built on Aug. 14, 2023, 9:07 a.m.