cfbfastR 1.2.1

v1.2.1

Minor release

• Added headshot_url to outputs of cfbd_team_rosters

• Renamed returns in cfbd_game_advanced():

  • rushing_line_yd_avg to plural rushing_line_yds_avg
  • rushing_second_lvl_yd_avg to plural rushing_second_lvl_yds_avg
  • rushing_open_field_yd_avg to plural rushing_open_field_yds_avg

• Completed documentation for all returns except cfbd_pbp_data()

• Continued work on intro vignette

v1.2.0-1

Add significant documentation to the package

• Added mini-vignettes pertaining to CFB Data functionality:

  • cfbd_betting,
  • cfbd_games,
  • cfbd_plays,
  • cfbd_recruiting,
  • cfbd_stats,
  • cfbd_teams

• Introductory vignette stub added

ESPN/CFBD metrics function variable return standardization

• Change id variable to team_id in espn_ratings_fpi()
• Changed espn_game_id variable to game_id in espn_metrics_wp(), corrected the away_win_percentage calculation and added tie_percentage to the returns.
• Change id variable to athlete_id in cfbd_metrics_ppa_players_season()

v1.1.0

Add loading from Data Repository functionality

• Added load_cfb_pbp() and update_cfb_db() functions. Pretty much cherry-picking the nflfastR methodology of loading data from the cfbfastR-data repository.

Add support for parallel processing and progress updates

• Added furrr, future, and progressr 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() has the parameter epa_wpa=FALSE. It has now been separated into its own function for clarity cfbd_plays(). The parameter and functionality still exists in cfbd_pbp_data() 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() and espn_metrics_wp()

• Data generated from any of the cfbfastR methods will use cfb_

College Football Data API Keys

The CollegeFootballData API 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.

• 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()). Run usethis::edit_r_environ() and THEN paste the following in the new script that pops up (without quotations)

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.

Sys.setenv(CFBD_API_KEY = "XXXX-YOUR-API-KEY-HERE-XXXXX")

• Added API Key methods. If you forget to set your environment variable, functions will give you a warning and ask for one.