-
Notifications
You must be signed in to change notification settings - Fork 99
/
README.Rmd
188 lines (135 loc) · 8.99 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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
---
output: github_document
---
```{r readme_setup, include = FALSE}
# You can install using the pacman package using the following code:
if (!requireNamespace('pacman', quietly = TRUE)){
install.packages('pacman')
}
pacman::p_load(dplyr)
```
#
# `baseballr` <a href='https://billpetti.github.io/baseballr/'><img src='https://raw.githubusercontent.com/billpetti/baseballr/master/logo.png' align="right" width="30%" min-width="100px" /></a>
<!-- badges: start -->
[](https://CRAN.R-project.org/package=baseballr)
[](https://CRAN.R-project.org/package=baseballr)
[](https://github.com/BillPetti/baseballr/)
[](https://github.com/BillPetti/baseballr/actions/workflows/R-CMD-check.yaml)
[](https://github.com/BillPetti/baseballr/)
[](https://github.com/BillPetti/baseballr/graphs/contributors)
<!-- badges: end -->
`baseballr` is a package written for R focused on baseball analysis. It
includes functions for scraping various data from websites, such as
[FanGraphs.com](https://www.fangraphs.com/), [Baseball-Reference.com](https://www.baseball-reference.com/), and [baseballsavant.mlb.com](https://baseballsavant.mlb.com/). It also
includes functions for calculating metrics, such as wOBA, FIP, and
team-level consistency over custom time frames.
You can read more about some of the functions and how to use them at its
[official site](https://billpetti.github.io/baseballr/) as well as this
[Hardball Times
article](https://tht.fangraphs.com/developing-the-baseballr-package-for-r/).
## Installation
You can install the CRAN version of
[**`baseballr`**](https://CRAN.R-project.org/package=baseballr)
with:
``` r
install.packages("baseballr")
```
You can install the released version of [**```baseballr```**](https://github.com/BillPetti/baseballr) from [GitHub](https://github.com/BillPetti/baseballr) 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("BillPetti/baseballr")
```
``` r
# Alternatively, using the devtools package:
if (!requireNamespace('devtools', quietly = TRUE)){
install.packages('devtools')
}
devtools::install_github(repo = "BillPetti/baseballr")
```
For experimental functions in development, you can install the [development branch](https://github.com/BillPetti/baseballr/tree/development_branch):
``` r
# install.packages("devtools")
devtools::install_github("BillPetti/baseballr", ref = "development_branch")
```
## **Functionality**
The package consists of two main sets of functions: data acquisition and metric calculation.
For example, if you want to see the standings for a specific MLB division on a given date, you can use the `bref_standings_on_date()` function. Just pass the year, month, day, and division you want:
```{r bref_standings_on_date}
library(baseballr)
library(dplyr)
bref_standings_on_date("2015-08-01", "NL East", from = FALSE)
```
Right now the function works as far as back as 1994, which is when both leagues split into three divisions.
You can also pull data for all hitters over a specific date range. Here are the results for all hitters from August 1st through October 3rd during the 2015 season:
```{r bref_daily_batter}
data <- bref_daily_batter("2015-08-01", "2015-10-03")
data %>%
dplyr::glimpse()
```
In terms of metric calculation, the package allows the user to calculate the consistency of team scoring and run prevention for any year using `team_consistency()`:
```{r team_consistency}
team_consistency(2015)
```
You can also calculate wOBA per plate appearance and wOBA on contact for any set of data over any date range, provided you have the data available.
Simply pass the proper data frame to `woba_plus`:
```{r woba}
data %>%
dplyr::filter(PA > 200) %>%
woba_plus %>%
dplyr::arrange(desc(wOBA)) %>%
dplyr::select(Name, Team, season, PA, wOBA, wOBA_CON) %>%
dplyr::glimpse()
```
You can also generate these wOBA-based stats, as well as FIP, for pitchers using the `fip_plus()` function:
```{r bref_daily_pitcher}
bref_daily_pitcher("2015-04-05", "2015-04-30") %>%
fip_plus() %>%
dplyr::select(season, Name, IP, ERA, SO, uBB, HBP, HR, FIP, wOBA_against, wOBA_CON_against) %>%
dplyr::arrange(dplyr::desc(IP)) %>%
head(10)
```
## **Issues**
Please leave any suggestions or bugs in the [Issues section](https://github.com/billpetti/baseballr/issues).
## **Pull Requests**
Pull request are welcome, but I cannot guarantee that they will be accepted or accepted quickly. Please make all pull requests to the [development branch](https://github.com/billpetti/baseballr/tree/development_branch) for review.
## **Breaking Changes**
[**Full News on Releases**](https://billpetti.github.io/baseballr/news/index.html)
## Follow the SportsDataverse (@SportsDataverse) on Twitter and star this repo
<!-- [](https://twitter.com/SportsDataverse) -->
[](https://github.com/billpetti/baseballr/stargazers/)
## **Our Authors**
- Bill Petti (@BillPetti)
<!-- <a href="https://twitter.com/BillPetti" target="blank"><img src="https://img.shields.io/twitter/follow/BillPetti?color=blue&label=%40BillPetti&logo=twitter&style=for-the-badge" alt="@BillPetti" /></a> -->
<a href="https://github.com/BillPetti" target="blank"><img src="https://img.shields.io/github/followers/BillPetti?color=eee&logo=Github&style=for-the-badge" alt="@BillPetti" /></a>
- 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>
## **Our Contributors (they're awesome)**
- Ben Baumer (@BaumerBen)
<!-- <a href="https://twitter.com/BaumerBen" target="blank"><img src="https://img.shields.io/twitter/follow/BaumerBen?color=blue&label=%40BaumerBen&logo=twitter&style=for-the-badge" alt="@BaumerBen" /></a> -->
<a href="https://github.com/beanumber" target="blank"><img src="https://img.shields.io/github/followers/beanumber?color=eee&logo=Github&style=for-the-badge" alt="@beanumber" /></a>
- Ben Dilday (@BenDilday)
<!-- <a href="https://twitter.com/BenDilday" target="blank"><img src="https://img.shields.io/twitter/follow/BenDilday?color=blue&label=%40BenDilday&logo=twitter&style=for-the-badge" alt="@BenDilday" /></a> -->
<a href="https://github.com/bdilday" target="blank"><img src="https://img.shields.io/github/followers/bdilday?color=eee&logo=Github&style=for-the-badge" alt="@bdilday" /></a>
- Robert Frey (@RobertFrey40)
<!-- <a href="https://twitter.com/RobertFrey40" target="blank"><img src="https://img.shields.io/twitter/follow/RobertFrey40?color=blue&label=%40RobertFrey40&logo=twitter&style=for-the-badge" alt="@RobertFrey40" /></a> -->
<a href="https://github.com/robert-frey" target="blank"><img src="https://img.shields.io/github/followers/robert-frey?color=eee&logo=Github&style=for-the-badge" alt="@robert-frey" /></a>
- Camden Kay (@k_camden)
<!-- <a href="https://twitter.com/k_camden" target="blank"><img src="https://img.shields.io/twitter/follow/k_camden?color=blue&label=%40k_camden&logo=twitter&style=for-the-badge" alt="@k_camden" /></a> -->
<a href="https://github.com/camdenk" target="blank"><img src="https://img.shields.io/github/followers/camdenk?color=eee&logo=Github&style=for-the-badge" alt="@camdenk" /></a>
## **Citations**
To cite the [**`baseballr`**](https://billpetti.github.io/baseballr/) R package in publications, use:
BibTex Citation
```bibtex
@misc{petti_gilani_2021,
author = {Bill Petti and Saiem Gilani},
title = {baseballr: The SportsDataverse's R Package for Baseball Data.},
url = {https://billpetti.github.io/baseballr/},
year = {2021}
}
```