README.md

nfl4th

R-CMD-check CRAN
status Lifecycle:
stable Support
Server

This is the package that powers the fourth down calculator introduced in this piece on The Athletic.

The code that powers the Twitter fourth down bot is in this folder here and the code that runs the Shiny app is here.

Installation

The easiest way to get the released version of nfl4th is to install it from CRAN with:

install.packages("nfl4th")

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

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

or by using remotes:

if (!require("remotes")) install.packages("remotes")
remotes::install_github("nflverse/nfl4th")

Features

Current limitations

There are some edge cases that are not accounted for. These should only make a marginal difference to the recommendations as they are largely edge cases (e.g. the possibility for a field goal to be blocked and returned).

Get Started

To get started with nfl4th please see this article. Some examples of 4th down research using the package can be found here.



nflverse/nfl4th documentation built on Sept. 28, 2024, 2:30 a.m.