README.md

In nflplotR: NFL Logo Plots in 'ggplot2' and 'gt'

nflplotR

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:

• 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.

nflplotR documentation built on Sept. 11, 2024, 9:01 p.m.