Skip to content
/ cfbfastR Public

❗ This is a read-only mirror of the CRAN R package repository. cfbfastR — Access College Football Play by Play Data. Homepage: https://cfbfastR.sportsdataverse.org/https://github.com/sportsdataverse/cfbfastR Report bugs for this package: https://github.com/sportsdataverse/cfbfastR/issues

License

Notifications You must be signed in to change notification settings

cran/cfbfastR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

cfbfastR

CRAN version CRAN downloads Version-Number R-CMD-check Lifecycle:maturing Contributors Twitter Follow Twitter Follow

The goal of cfbfastR is to provide the community with an R package for working with CFB data. It is an R API wrapper around https://collegefootballdata.com/. Beyond data aggregation and tidying ease, one of the multitude of services that cfbfastR provides is for benchmarking open-source expected points and win probability metrics.

Installation

You can install the CRAN version of cfbfastR with:

install.packages("cfbfastR")

You can install the released version of cfbfastR from GitHub with:

# 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/cfbfastR", dependencies = TRUE, update = TRUE)

Breaking Changes

Full News on Releases

College Football Data API Keys

The CollegeFootballData API now requires an API key, here’s a quick run-down:

CFBD_API_KEY = XXXX-YOUR-API-KEY-HERE-XXXXX

Save the script and restart your RStudio session, by clicking Session (in between Plots and Build) and click Restart R (there also exists the shortcut Ctrl + Shift + F10 to restart your session). If set correctly, from then on you should be able to use any of the cfbd_ functions without any other changes.

  • 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.
Sys.setenv(CFBD_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX")

Follow cfbfastR and the SportsDataverse on Twitter and star this repo

Twitter Follow Twitter Follow

GitHub stars

Our Authors

Our Contributors (they’re awesome)

Authors Emeritus - cfbscrapR[archived]

Special Thanks

Citations

To cite the cfbfastR R package in publications, use:

BibTex Citation

@misc{gilani_et_al_2021_cfbfastr,
  author = {Saiem Gilani and Akshay Easwaran and Jared Lee and Eric Hess},
  title = {cfbfastR: The SportsDataverse's R Package for College Football Data.},
  url = {https://cfbfastR.sportsdataverse.org/},
  year = {2021}
}

About

❗ This is a read-only mirror of the CRAN R package repository. cfbfastR — Access College Football Play by Play Data. Homepage: https://cfbfastR.sportsdataverse.org/https://github.com/sportsdataverse/cfbfastR Report bugs for this package: https://github.com/sportsdataverse/cfbfastR/issues

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages