-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
76 lines (50 loc) · 3.91 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
74
75
---
output: github_document
---
# usfootballR <a href='https://usfootballR.sportsdataverse.org/'><img src="https://raw.githubusercontent.com/sportsdataverse/usfootballR/master/man/figures/logo.png" align="right" width="20%" min-width="100px"/></a>
```{r setup_readme, include = FALSE}
require(knitr)
if (!requireNamespace('pacman')){
install.packages('pacman')
}
pacman::p_load(magick, grid, dplyr, lubridate)
# You can install using the pacman package using the following code:
```
<!-- badges: start -->
[](https://github.com/sportsdataverse/usfootballR) [](https://github.com/sportsdataverse/usfootballR/actions/workflows/R-CMD-check.yaml) [](https://github.com/sportsdataverse/usfootballR)
[](https://twitter.com/saiemgilani)
[](https://twitter.com/sportsdataverse)
<!-- badges: end -->
`usfootballR` is an R package for working with American soccer data. The package has functions to access **live play-by-play and box score** data from ESPN with shot locations when available.
A scraping and aggregating interface for ESPN's MLS and NWSL statistics. It provides users with the capability to access the API's game play-by-plays, box scores, standings and results to analyze the data for themselves.
## Installation
You can install the released version of [**`usfootballR`**](https://github.com/sportsdataverse/usfootballR) from [GitHub](https://github.com/sportsdataverse/usfootballR) with:
```{r pacman_readme, eval=FALSE}
# You can install using the pacman package using the following code:
if (!requireNamespace('pacman', quietly = TRUE)){
install.packages('pacman')
}
pacman::p_load_current_gh("sportsdataverse/usfootballR", dependencies = TRUE, update = TRUE)
```
## Documentation
For more information on the package and function reference, please see the [**`usfootballR`** documentation website](https://usfootballR.sportsdataverse.org).
## **Breaking Changes**
[**Full News on Releases**](https://usfootballR.sportsdataverse.org/CHANGELOG)
## Follow the [SportsDataverse](https://twitter.com/SportsDataverse) on Twitter and star this repo
[](https://twitter.com/SportsDataverse)
[](https://github.com/sportsdataverse/usfootballR/stargazers/)
# **Our Authors**
- [Saiem Gilani](https://twitter.com/saiemgilani)
<a href="https://twitter.com/saiemgilani" target="blank"><img src="https://img.shields.io/twitter/follow/saiemgilani?color=blue&label=%40saiemgilani&logo=twitter&style=for-the-badge" alt="@saiemgilani" /></a>
<a href="https://github.com/saiemgilani" target="blank"><img src="https://img.shields.io/github/followers/saiemgilani?color=eee&logo=Github&style=for-the-badge" alt="@saiemgilani" /></a>
## **Citations**
To cite the [**`usfootballR`**](https://usfootballR.sportsdataverse.org) R package in publications, use:
BibTex Citation
```bibtex
@misc{gilani_2021_usfootballR,
author = {Saiem Gilani},
title = {usfootballR: The SportsDataverse's R Package for MLS and NWSL Data.},
url = {https://usfootballR.sportsdataverse.org},
year = {2021}
}
```