-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
118 lines (78 loc) · 6.67 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
---
output: github_document
---
#
# fastRhockey <a href='http://fastrhockey.sportsdataverse.org/'><img src='https://raw.githubusercontent.com/sportsdataverse/fastRhockey/main/logo.png' align="right" width="20%" min-width="100" /></a>
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
<!-- badges: start -->
[](https://CRAN.R-project.org/package=fastRhockey)
[](https://CRAN.R-project.org/package=fastRhockey)
[](https://github.com/sportsdataverse/fastRhockey/)
[](https://github.com/sportsdataverse/fastRhockey/actions/workflows/R-CMD-check.yaml) [](https://github.com/sportsdataverse/fastRhockey/) [](https://github.com/sportsdataverse/fastRhockey/graphs/contributors)
<!-- badges: end -->
[`fastRhockey`](https://github.com/sportsdataverse/fastRhockey) is an R Package that is designed to pull play-by-play (and boxscore) data from the newest version of the [Professional Women's Hockey League website](https://www.thepwhl.com/). In the past, there have been a few scrapers for the PHF (formerly the NWHL), but they have all been deprecated since the formation of the new PWHL league changed websites.
With the first season of the league kicking off on January 1st, and games being broadcast on ESPN+, this package was created to allow access to play-by-play data to continue pushing women's hockey analytics forward.
In Spring of 2021, the [Big Data Cup](https://www.theicegarden.com/2021/4/15/22374981/a-directory-of-womens-hockey-projects-from-big-data-cup-2021-analytics-otthac-stathletes) and the [data they made available](https://github.com/bigdatacup/Big-Data-Cup-2021) revolutionized what we were able to thanks to the detailed play-by-play data for the season and the x/y location data. That wave continued with the inaugural [WHKYHAC conference](https://www.whkyhac.com/) in July that produced some amazing conversations and projects in the women's hockey space.
In the past, the lack of data and poor access to data have been the biggest barrier to entry in women's hockey analytics, a barrier that this package intends to alleviate.
<center>
<img src='https://raw.githubusercontent.com/sportsdataverse/fastRhockey/main/man/figures/fastRhockey_full_holographic_graphic.png' width="70%" />
</center>
*****************************************************************
## Installation
You can install the CRAN version of [**```fastRhockey```** ](https://CRAN.R-project.org/package=fastRhockey) with:
```r
install.packages("fastRhockey")
```
You can install the released version of [**`fastRhockey`**](https://github.com/sportsdataverse/fastRhockey/) from [GitHub](https://github.com/sportsdataverse/fastRhockey) with:
``` r
# 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/fastRhockey", dependencies = TRUE, update = TRUE)
```
If you would prefer the `devtools` installation:
``` r
if (!requireNamespace('devtools', quietly = TRUE)){
install.packages('devtools')
}
devtools::install_github(repo = "sportsdataverse/fastRhockey")
```
*********************************************************
## Documentation
You can find the [documentation](https://fastRhockey.sportsdataverse.org/) for [**`fastRhockey`**](https://github.com/sportsdataverse/fastRhockey) on [GitHub pages](https://fastRhockey.sportsdataverse.org/).
You can view CSVs of historical boxscore and play-by-play on the [**`fastRhockey`**](https://github.com/sportsdataverse/fastRhockey/) [data repo](https://github.com/sportsdataverse/fastRhockey-data), as well as the process for scraping that historical data.
*********************************************************
## Breaking Changes
[**Full News on Releases**](http://fastrhockey.sportsdataverse.org/news/index.html)
********************************************************************
## Follow the SportsDataverse (@sportsdataverse) on Twitter and star this repo
[](https://github.com/sportsdataverse/fastRhockey/stargazers/)
## **Our Authors**
- Ben Howell (@BenHowell71)
<a href="https://github.com/BenHowell71" target="blank"><img src="https://img.shields.io/github/followers/BenHowell71?color=eee&logo=Github&style=for-the-badge" alt="@BenHowell71" /></a>
- Saiem Gilani (@saiemgilani)
<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>
## **Our Contributors (they're awesome)**
- Alyssa Longmuir (@alyssastweeting)
<a href="https://github.com/Aklongmuir" target="blank"><img src="https://img.shields.io/github/followers/Aklongmuir?color=eee&logo=Github&style=for-the-badge" alt="@Aklongmuir" /></a>
- Tan Ho (@_TanHo)
<a href="https://github.com/tanho63" target="blank"><img src="https://img.shields.io/github/followers/tanho63?color=eee&logo=Github&style=for-the-badge" alt="@tanho63" /></a>
## **Citations**
To cite the [**`fastRhockey`**](https://fastRhockey.sportsdataverse.org/) R package in publications, use:
BibTex Citation
```bibtex
@misc{howell_gilani_fastRhockey_2021,
author = {Ben Howell and Saiem Gilani},
title = {fastRhockey: The SportsDataverse's R Package for Hockey Data.},
url = {https://fastRhockey.sportsdataverse.org/},
year = {2021}
}
```