README.Rmd

---
output: github_document
---


```{r, include = FALSE, echo=FALSE}
require(knitr)
library(magick)
library(grid)
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "95%"
)
opts_template$set(stripfigure = list(fig.height = 8, out.width = "95%"))
```

# cfbscrapR **[archived]** <a href='http://saiemgilani.github.io/cfbscrapR'><img src='man/figures/logo.png' align="right" height="139" /></a>

## **This Repository is Archived -- Use [cfbfastR](https://github.com/saiemgilani/cfbfastR)**

*A scraping and aggregating package using the CollegeFootballData API*

*`cfbscrapR` is an R package for working with CFB data. It is an R API wrapper around <https://collegefootballdata.com/>. It provides users the capability to retrieve data from a plethora of endpoints and supplement that data with additional information (Expected Points Added/Win Probability added).*

*Note: The API ingests data from ESPN as well as other sources. For details on those source, please go the website linked above. Sometimes there are inconsistencies in the underlying data itself. Please report issues here or to <https://collegefootballdata.com/>.*

## *Installation*

*You can install `cfbscrapR` from [GitHub](https://github.com/saiemgilani/cfbscrapR) with:*

``` r
# Then can install using the devtools package from either of the following:
devtools::install_github(repo = "saiemgilani/cfbscrapR")
# or the following (these are the exact same packages):
devtools::install_github(repo = "meysubb/cfbscrapR")
```

## *Documentation*

*For more information on the package and [function reference](https://saiemgilani.github.io/cfbscrapR/reference/index.html), please see the `cfbscrapR` [documentation website](https://saiemgilani.github.io/cfbscrapR/).*

### *Expected Points and Win Probability models*

*If you would like to learn more about the Expected Points and Win Probability models, please refer to the `cfbscrapR` [tutorials](https://saiemgilani.github.io/cfbscrapR/articles/index.html) or for the code repository where the models are built, [click here](https://github.com/meysubb/cfbscrapR-MISC)* <center>

#### *Expected Points model calibration plots*

#### *(~~1.31%~~ ~~1.15%~~ 0.94% Calibration Error)*

![ep\_fg\_cv\_loso\_calibration\_results.png](https://github.com/saiemgilani/cfbscrapR/blob/master/man/figures/ep_fg_cv_loso_calibration_results.png?raw=true)

</center>

<center>


#### *Win Probability model calibration plots*

#### *(~~0.89%~~ ~~0.787%~~ 0.669% Calibration Error)*


<img src="https://github.com/saiemgilani/cfbscrapR/blob/master/man/figures/wp_cv_loso_calibration_results.png?raw=true" alt="wp_cv_loso_calibration_results.png" width="1800"/>

</center>

# *cfbscrapR 1.0.5*
-  *Added [Eric Hess](https://twitter.com/arbitanalytics)'s [Visualizing Team Talent Using Player Recruiting Rankings](https://saiemgilani.github.io/cfbscrapR/articles/nth-rated-recruit.html) vignette*
-  *Added [`cfb_calendar()`](https://saiemgilani.github.io/cfbscrapR/reference/cfb_calendar.html) function from API*
-  *Updated [`cfb_team_roster()`](https://saiemgilani.github.io/cfbscrapR/reference/cfb_team_roster.html) to reflect new parameters.*

# *cfbscrapR 1.0.4*

-  *Updated [`cfb_game_box_advanced()`](https://saiemgilani.github.io/cfbscrapR/reference/cfb_game_box_advanced.html) to incorporate new columns from API.*

# *cfbscrapR 1.0.3*

*This was a big update!*

-   *Updated expected points models and win probability models*
-   *Add player and yardage columns to [`cfb_pbp_data()`](https://saiemgilani.github.io/cfbscrapR/reference/cfb_pbp_data.html) pull thanks to a great deal of help from [\@NickTice](https://github.com/NickTice)*
-   *Add spread values to the [`cfb_pbp_data()`](https://saiemgilani.github.io/cfbscrapR/reference/cfb_pbp_data.html) pull*
-   *Add drive detailed result with attempts at creating more accurate drive result labels*
-   *Added series and first down variables*
-   *Added argumentation to allow for San Jose State to be entered without accent into [`cfb_pbp_data()`](https://saiemgilani.github.io/cfbscrapR/reference/cfb_pbp_data.html) function ```team``` argument.*