-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathREADME.Rmd
122 lines (86 loc) · 6.07 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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
---
output: github_document
---
# wehoop <a href='https://wehoop.sportsdataverse.org'><img src="https://raw.githubusercontent.com/sportsdataverse/wehoop/main/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(wehoop, magick, grid, dplyr, lubridate)
# You can install using the pacman package using the following code:
```
<!-- badges: start -->
[](https://CRAN.R-project.org/package=wehoop)
[](https://CRAN.R-project.org/package=wehoop)
[](https://github.com/sportsdataverse/wehoop) [](https://github.com/sportsdataverse/wehoop/actions/workflows/R-CMD-check.yaml) [](https://github.com/sportsdataverse/wehoop)
<!-- [](https://twitter.com/SaiemGilani) -->
<!-- [](https://twitter.com/hutchngo) [](https://twitter.com/sportsdataverse) -->
<!-- badges: end -->
`wehoop` is an R package for working with women's college and professional basketball 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 women's college basketball and WNBA 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 CRAN version of [**```wehoop```** ](https://CRAN.R-project.org/package=wehoop) with:
```{r readme_cran_install, eval=FALSE}
install.packages("wehoop")
```
You can install the released version of [**`wehoop`**](https://github.com/sportsdataverse/wehoop) from [GitHub](https://github.com/sportsdataverse/wehoop) 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/wehoop", dependencies = TRUE, update = TRUE)
```
## **Quick Start**
### **WNBA full play-by-play seasons (2002-`r wehoop::most_recent_wnba_season()`) ~ 1-2 minutes**
```{r wnba_load_pbp_readme}
tictoc::tic()
progressr::with_progress({
wnba_pbp <- wehoop::load_wnba_pbp()
})
tictoc::toc()
```
```{r wnba_pbp_message, echo = FALSE}
glue::glue("{nrow(wnba_pbp)} rows of WNBA play-by-play data from {length(unique(wnba_pbp$game_id))} games.")
```
### **Women's college basketball full play-by-play seasons (2004-`r wehoop::most_recent_wbb_season()`) ~ 2-3 minutes**
```{r wbb_load_pbp_readme}
tictoc::tic()
progressr::with_progress({
wbb_pbp <- wehoop::load_wbb_pbp()
})
tictoc::toc()
```
```{r wbb_pbp_message, echo = FALSE}
glue::glue("{nrow(wbb_pbp)} rows of women's college basketball play-by-play data from {length(unique(wbb_pbp$game_id))} games.")
```
## **Documentation**
For more information on the package and function reference, please see the [**`wehoop`** documentation website](https://wehoop.sportsdataverse.org).
## **Breaking Changes**
[**Full News on Releases**](https://wehoop.sportsdataverse.org/news/index.html)
## Follow the SportsDataverse (@SportsDataverse) on Twitter and star this repo
<!-- [](https://twitter.com/SportsDataverse) -->
[](https://github.com/sportsdataverse/wehoop/stargazers/)
# **Our Authors**
- Saiem Gilani (@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>
- Geoff Hutchinson (@HutchNGo)
<!-- <a href="https://twitter.com/HutchNGo" target="blank"><img src="https://img.shields.io/twitter/follow/HutchNGo?color=blue&label=%40hutchngo&logo=twitter&style=for-the-badge" alt="@HutchNGo" /></a> -->
<a href="https://github.com/hutchngo" target="blank"><img src="https://img.shields.io/github/followers/hutchngo?color=eee&logo=Github&style=for-the-badge" alt="@hutchngo" /></a>
## **Citations**
To cite the [**`wehoop`**](https://wehoop.sportsdataverse.org) R package in publications, use:
BibTex Citation
```bibtex
@misc{hutchinson_gilani_2021_wehoop,
title = {wehoop: Access Women’s Basketball Play by Play Data},
url = {http://doi.org/10.32614/CRAN.package.wehoop},
DOI = {10.32614/cran.package.wehoop},
journal = {CRAN: Contributed Packages},
publisher = {The R Foundation},
author = {Gilani, Saiem and Hutchinson, Geoffery},
year = {2021},
month = nov
}
```