Skip to content

Latest commit

 

History

History
87 lines (64 loc) · 3.28 KB

README.md

File metadata and controls

87 lines (64 loc) · 3.28 KB

nflplotR

CRAN status CRAN downloads Dev status R build status Lifecycle: experimental nflverse support Codecov test coverage

The goal of nflplotR is to provide functions and geoms that help visualization of NFL related analysis. It provides a ggplot2 geom that does the heavy lifting of plotting NFL logos in high quality, with correct aspect ratio and possible transparency.

Installation

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

install.packages("nflplotR")

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

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

or prebuilt from the development repo with:

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

Usage

Please see the Get Started with nflplotR and nflplotR & the gt Package articles.

Getting help

The best places to get help on this package are:

Contributing

Many hands make light work! Here are some ways you can contribute to this project:

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.