-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
73 lines (50 loc) · 3.48 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# nflplotR <a href='https://nflplotr.nflverse.com'><img src='man/figures/logo.png' align="right" width="25%" min-width="120px" /></a>
<!-- badges: start -->
[](https://CRAN.R-project.org/package=nflplotR)
[](https://CRAN.R-project.org/package=nflplotR)
[](https://nflplotr.nflverse.com)
[](https://github.com/nflverse/nflplotR/actions)
[](https://lifecycle.r-lib.org/articles/stages.html)
[](https://discord.com/invite/5Er2FBnnQa)
[](https://app.codecov.io/gh/nflverse/nflplotR)
<!-- badges: end -->
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](https://cran.r-project.org/package=nflplotR) with:
``` r
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](https://github.com/nflverse/nflplotR/) with:
```{r eval = FALSE}
if (!require("pak")) install.packages("pak")
pak::pak("nflverse/nflplotR")
```
or prebuilt from the [development repo](https://nflverse.r-universe.dev) with:
```{r eval = FALSE}
install.packages("nflplotR", repos = c("https://nflverse.r-universe.dev", getOption("repos")))
```
## Usage
Please see the **[Get Started with nflplotR](https://nflplotr.nflverse.com/articles/nflplotR.html)** and **[nflplotR & the gt Package](https://nflplotr.nflverse.com/articles/gt.html)** articles.
## 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/nflplotR/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/nflplotR/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://nflplotr.nflverse.com/CONTRIBUTING.html).
## Terms of Use
The R code for this package is released as open source under the [MIT License](https://nflplotr.nflverse.com/LICENSE.html). NFL data accessed by this package belong to their respective owners, and are governed by their terms of use.