From 531198e05b7846234330142450071356da40dcba Mon Sep 17 00:00:00 2001 From: runner Date: Sun, 18 Apr 2021 23:50:43 +0000 Subject: [PATCH] Re-build README.Rmd --- README.md | 400 +++++++++++++++++++++++++++--------------------------- 1 file changed, 200 insertions(+), 200 deletions(-) diff --git a/README.md b/README.md index a70d85da..dce92f81 100644 --- a/README.md +++ b/README.md @@ -1,200 +1,200 @@ - -# **cfbfastR** - - - -![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg?style=for-the-badge&logo=github) -![R-CMD-check](https://img.shields.io/github/workflow/status/saiemgilani/cfbfastr/R-CMD-check?label=R-CMD-Check&logo=R&logoColor=blue&style=for-the-badge) -![Contributors](https://img.shields.io/github/contributors/saiemgilani/cfbfastR?style=for-the-badge) -![Version-Number](https://img.shields.io/github/r-package/v/saiemgilani/cfbfastr?label=cfbfastR&logo=R&style=for-the-badge) -[![Twitter -Follow](https://img.shields.io/twitter/follow/cfbfastR?color=blue&label=%40cfbfastR&logo=twitter&style=for-the-badge)](https://twitter.com/cfbfastR) - - - -The goal of [**`cfbfastR`**](https://saiemgilani.github.io/cfbfastR/) is -to provide the community with an R package for working with CFB data. It -is an R API wrapper around . - -## **Installation** - -You can install the released version of -[**`cfbfastR`**](https://github.com/saiemgilani/cfbfastR/) from -[GitHub](https://github.com/saiemgilani/cfbfastR) with: - -``` r -# You can install using the pacman package using the following code: -if (!requireNamespace('pacman')){ - install.packages('pacman') -} -pacman::p_load_gh("saiemgilani/cfbfastR") -``` - -``` r -# if you would prefer devtools installation -if (!requireNamespace('devtools')){ - install.packages('devtools') -} -# Alternatively, using the devtools package: -devtools::install_github(repo = "saiemgilani/cfbfastR") -``` - -## **Breaking Changes** - -### **v1.1.0** - -#### **Add loading from Data Repository functionality** - - - Added - [`load_cfb_pbp()`](https://saiemgilani.github.io/cfbfastR/reference/load_cfb_pbp.html) - and - [`update_cfb_db()`](https://saiemgilani.github.io/cfbfastR/reference/update_cfb_db.html) - functions. Pretty much piggy-backing on the `nflfastR` methodology - of loading data from the - [`cfbfastR-data`](https://github.com/saiemgilani/cfbfastR-data/) - repository. - -#### **Add support for parallel processing and progress updates** - - - Added [`furrr`](https://furrr.futureverse.org/index.html), - [`future`](https://future.futureverse.org/), and - [`progressr`](https://progressr.futureverse.org/) dependencies to - the package to allow for parallel processing of the play-by-play - data with progress updates if desired. - -### **v1.0.0** - -#### **Function Naming Convention Change** - - - All functions sourced from the College Football Data API will start - with `cfbd_` as opposed to `cfb_` (as in cfbscrapR). One additional - `cfbd_` function has been added that corresponds to the result when - [`cfbd_pbp_data()`](https://saiemgilani.github.io/cfbfastR/reference/cfbd_pbp_data.html) - has the parameter `epa_wpa=FALSE`. It has now been separated into - its own function for clarity - [`cfbd_plays()`](https://saiemgilani.github.io/cfbfastR/reference/cfbd_play.html). - The parameter and functionality still exists in - [`cfbd_pbp_data()`](https://saiemgilani.github.io/cfbfastR/reference/cfbd_pbp_data.html) - but we expect this function will still exist but made obsolete in - favor of a function more closely matching `nflfastR`’s naming - conventions. - - - Similarly, data and metrics sourced from ESPN will begin with - `espn_` as opposed to `cfb_`. In particular, the two functions are - now - [`espn_ratings_fpi()`](https://saiemgilani.github.io/cfbfastR/reference/espn_ratings.html) - and - [`espn_metrics_wp()`](https://saiemgilani.github.io/cfbfastR/reference/espn_metrics.html) - - - Data generated from any of the `cfbfastR` methods will use `cfb_` - -#### **CollegeFootballData API Keys** - -The [CollegeFootballData API](https://collegefootballdata.com/) now -requires an API key, here’s a quick run-down: - - - To get an API key, follow the directions here: [College Football - Data Key Registration.](https://collegefootballdata.com/key) - - - Using the key: You can save the key for consistent usage by adding - `CFBD_API_KEY=XXXX-YOUR-API-KEY-HERE-XXXXX` to your .REnviron file - (easily accessed via - [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)). - -Run -[**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html) -and THEN paste the following in the new script that pops up (with**out** -quotations) - -``` r -CFBD_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX -``` - - - For less consistent usage: At the beginning of every session or - within an R environment, save your API key as the environment - variable `CFBD_API_KEY` (with quotations) using a command like the - following. - - - -``` r -Sys.setenv(CFBD_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX") -``` - - - Added [API Key - methods](https://saiemgilani.github.io/cfbfastR/reference/register_cfbd.html). - If you forget to set your environment variable, functions will give - you a warning and ask for one. - -## Current Issues - -| issue | icon | title | labels | opened\_by | comments | comments\_users | assigned\_to | created | updated | closed | -| :---- | :--------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------ | :------------------------------------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------- | :------------------ | :------------------ | :----- | -| 4 | | [cfbd\_play\_types is documented, but isn’t in the package](https://github.com/saiemgilani/cfbfastR/issues/4) | documentation | [rchanks](https://github.com/rchanks) | 1 | [saiemgilani](https://github.com/saiemgilani/cfbfastR/issues/4#issuecomment-820774552) | saiemgilani | 2021-04-15 16:11:17 | 2021-04-15 22:58:01 | NA | -| 5 | | [Play by play for data 2013 and before](https://github.com/saiemgilani/cfbfastR/issues/5) | bug | [rchanks](https://github.com/rchanks) | 1 | [saiemgilani](https://github.com/saiemgilani/cfbfastR/issues/5#issuecomment-820774185) | saiemgilani | 2021-04-15 16:24:03 | 2021-04-15 22:48:48 | NA | - -
- -View More - -| issue | icon | title | labels | opened\_by | comments | comments\_users | assigned\_to | created | updated | closed | -| :---- | :--- | :---- | :----- | :--------- | :------- | :-------------- | :----------- | :------ | :------ | :----- | - -
- -
- -## **Our Authors** - - - [Saiem Gilani](https://twitter.com/saiemgilani) - @saiemgilani - @saiemgilani - - - [Akshay Easwaran](https://twitter.com/akeaswaran) - @akeaswaran - @akeaswaran - - - [Jared Lee](https://twitter.com/JaredDLee)
- @JaredDLee - @Kazink36 - - - [Eric Hess](https://twitter.com/arbitanalytics)
- @arbitanalytics - @ehess - -## **Our Contributors (they’re awesome)** - - - [Nate Manzo](https://twitter.com/cfbnate) - @cfbnate - @natemanzo - - [Michael Egle](https://twitter.com/deceptivespeed_) - @deceptivespeed_ - @michaelegle - - [Jason DeLoach](https://twitter.com/CFBNumbers) - @CFBNumbers - @CFBNumbers - - [Tej Seth](https://twitter.com/Tejseth41) - @Tejseth41 - @tejseth - - [Conor McQuiston](https://twitter.com/ConorMcQ5) - @ConorMcQ5 - @mcqconor - - [Tan Ho](https://twitter.com/_TanHo) - @_TanHo - @tanho63 - -## **Authors Emeritus - `cfbscrapR`\[archived\]** - - - [Meyappan Subbiah](https://twitter.com/msubbaiah1) - @msubbaiah1 - @meysubb - - [Parker Fleming](https://twitter.com/statsowar) - @statsowar - @spfleming - -## **Special Thanks** - - - [Nick Tice](https://github.com/NickTice) - - [Sebastian Carl](https://twitter.com/mrcaseb) - @mrcaseb - @mrcaseb + +# **cfbfastR** + + + +![Lifecycle:maturing](https://img.shields.io/badge/lifecycle-maturing-blue.svg?style=for-the-badge&logo=github) +![R-CMD-check](https://img.shields.io/github/workflow/status/saiemgilani/cfbfastr/R-CMD-check?label=R-CMD-Check&logo=R&logoColor=blue&style=for-the-badge) +![Contributors](https://img.shields.io/github/contributors/saiemgilani/cfbfastR?style=for-the-badge) +![Version-Number](https://img.shields.io/github/r-package/v/saiemgilani/cfbfastr?label=cfbfastR&logo=R&style=for-the-badge) +[![Twitter +Follow](https://img.shields.io/twitter/follow/cfbfastR?color=blue&label=%40cfbfastR&logo=twitter&style=for-the-badge)](https://twitter.com/cfbfastR) + + + +The goal of [**`cfbfastR`**](https://saiemgilani.github.io/cfbfastR/) is +to provide the community with an R package for working with CFB data. It +is an R API wrapper around . + +## **Installation** + +You can install the released version of +[**`cfbfastR`**](https://github.com/saiemgilani/cfbfastR/) from +[GitHub](https://github.com/saiemgilani/cfbfastR) with: + +``` r +# You can install using the pacman package using the following code: +if (!requireNamespace('pacman')){ + install.packages('pacman') +} +pacman::p_load_gh("saiemgilani/cfbfastR") +``` + +``` r +# if you would prefer devtools installation +if (!requireNamespace('devtools')){ + install.packages('devtools') +} +# Alternatively, using the devtools package: +devtools::install_github(repo = "saiemgilani/cfbfastR") +``` + +## **Breaking Changes** + +### **v1.1.0** + +#### **Add loading from Data Repository functionality** + + - Added + [`load_cfb_pbp()`](https://saiemgilani.github.io/cfbfastR/reference/load_cfb_pbp.html) + and + [`update_cfb_db()`](https://saiemgilani.github.io/cfbfastR/reference/update_cfb_db.html) + functions. Pretty much piggy-backing on the `nflfastR` methodology + of loading data from the + [`cfbfastR-data`](https://github.com/saiemgilani/cfbfastR-data/) + repository. + +#### **Add support for parallel processing and progress updates** + + - Added [`furrr`](https://furrr.futureverse.org/index.html), + [`future`](https://future.futureverse.org/), and + [`progressr`](https://progressr.futureverse.org/) dependencies to + the package to allow for parallel processing of the play-by-play + data with progress updates if desired. + +### **v1.0.0** + +#### **Function Naming Convention Change** + + - All functions sourced from the College Football Data API will start + with `cfbd_` as opposed to `cfb_` (as in cfbscrapR). One additional + `cfbd_` function has been added that corresponds to the result when + [`cfbd_pbp_data()`](https://saiemgilani.github.io/cfbfastR/reference/cfbd_pbp_data.html) + has the parameter `epa_wpa=FALSE`. It has now been separated into + its own function for clarity + [`cfbd_plays()`](https://saiemgilani.github.io/cfbfastR/reference/cfbd_play.html). + The parameter and functionality still exists in + [`cfbd_pbp_data()`](https://saiemgilani.github.io/cfbfastR/reference/cfbd_pbp_data.html) + but we expect this function will still exist but made obsolete in + favor of a function more closely matching `nflfastR`’s naming + conventions. + + - Similarly, data and metrics sourced from ESPN will begin with + `espn_` as opposed to `cfb_`. In particular, the two functions are + now + [`espn_ratings_fpi()`](https://saiemgilani.github.io/cfbfastR/reference/espn_ratings.html) + and + [`espn_metrics_wp()`](https://saiemgilani.github.io/cfbfastR/reference/espn_metrics.html) + + - Data generated from any of the `cfbfastR` methods will use `cfb_` + +#### **CollegeFootballData API Keys** + +The [CollegeFootballData API](https://collegefootballdata.com/) now +requires an API key, here’s a quick run-down: + + - To get an API key, follow the directions here: [College Football + Data Key Registration.](https://collegefootballdata.com/key) + + - Using the key: You can save the key for consistent usage by adding + `CFBD_API_KEY=XXXX-YOUR-API-KEY-HERE-XXXXX` to your .REnviron file + (easily accessed via + [**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html)). + +Run +[**`usethis::edit_r_environ()`**](https://usethis.r-lib.org/reference/edit.html) +and THEN paste the following in the new script that pops up (with**out** +quotations) + +``` r +CFBD_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX +``` + + - For less consistent usage: At the beginning of every session or + within an R environment, save your API key as the environment + variable `CFBD_API_KEY` (with quotations) using a command like the + following. + + + +``` r +Sys.setenv(CFBD_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX") +``` + + - Added [API Key + methods](https://saiemgilani.github.io/cfbfastR/reference/register_cfbd.html). + If you forget to set your environment variable, functions will give + you a warning and ask for one. + +## Current Issues + +| issue | icon | title | labels | opened\_by | comments | comments\_users | assigned\_to | created | updated | closed | +| :---- | :----------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------ | :------------------------------------ | :------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----------- | :------------------ | :------------------ | :------------------ | +| 5 | | [Play by play for data 2013 and before](https://github.com/saiemgilani/cfbfastR/issues/5) | bug | [rchanks](https://github.com/rchanks) | 1 | [saiemgilani](https://github.com/saiemgilani/cfbfastR/issues/5#issuecomment-820774185) | saiemgilani | 2021-04-15 16:24:03 | 2021-04-15 22:48:48 | NA | +| 4 | | [cfbd\_play\_types is documented, but isn’t in the package](https://github.com/saiemgilani/cfbfastR/issues/4) | documentation | [rchanks](https://github.com/rchanks) | 1 | [saiemgilani](https://github.com/saiemgilani/cfbfastR/issues/4#issuecomment-820774552) | saiemgilani | 2021-04-15 16:11:17 | 2021-04-18 23:47:31 | 2021-04-18 23:47:31 | + +
+ +View More + +| issue | icon | title | labels | opened\_by | comments | comments\_users | assigned\_to | created | updated | closed | +| :---- | :--- | :---- | :----- | :--------- | :------- | :-------------- | :----------- | :------ | :------ | :----- | + +
+ +
+ +## **Our Authors** + + - [Saiem Gilani](https://twitter.com/saiemgilani) + @saiemgilani + @saiemgilani + + - [Akshay Easwaran](https://twitter.com/akeaswaran) + @akeaswaran + @akeaswaran + + - [Jared Lee](https://twitter.com/JaredDLee)
+ @JaredDLee + @Kazink36 + + - [Eric Hess](https://twitter.com/arbitanalytics)
+ @arbitanalytics + @ehess + +## **Our Contributors (they’re awesome)** + + - [Nate Manzo](https://twitter.com/cfbnate) + @cfbnate + @natemanzo + - [Michael Egle](https://twitter.com/deceptivespeed_) + @deceptivespeed_ + @michaelegle + - [Jason DeLoach](https://twitter.com/CFBNumbers) + @CFBNumbers + @CFBNumbers + - [Tej Seth](https://twitter.com/Tejseth41) + @Tejseth41 + @tejseth + - [Conor McQuiston](https://twitter.com/ConorMcQ5) + @ConorMcQ5 + @mcqconor + - [Tan Ho](https://twitter.com/_TanHo) + @_TanHo + @tanho63 + +## **Authors Emeritus - `cfbscrapR`\[archived\]** + + - [Meyappan Subbiah](https://twitter.com/msubbaiah1) + @msubbaiah1 + @meysubb + - [Parker Fleming](https://twitter.com/statsowar) + @statsowar + @spfleming + +## **Special Thanks** + + - [Nick Tice](https://github.com/NickTice) + - [Sebastian Carl](https://twitter.com/mrcaseb) + @mrcaseb + @mrcaseb