# Access College Football Play by Play Data

## Documentation for package ‘cfbfastR’ version 3.0.0

- DESCRIPTION file
- Package NEWS
- Package README

## Help Pages

A B C D E F G H I L M N P R S T U Y

## -- A --

api_key | *CFBD API Key Endpoint Overview*
athletes | *ESPN College Football Player Endpoint Overview*
awards | *ESPN College Football Catalog Endpoint Overview*

## -- B --

betting | *CFBD Betting Endpoint Overview*

## -- C --

catalog | *ESPN College Football Catalog Endpoint Overview*
cfbd_api_key | *CFBD API Key Endpoint Overview*
cfbd_api_key_info | *CFBD API Key Registration*
cfbd_betting | *CFBD Betting Endpoint Overview*
cfbd_betting_ats | *CFBD Against-the-Spread (ATS) Records*
cfbd_betting_lines | *CFBD Betting Lines Endpoint Overview*
cfbd_calendar | *Get calendar of weeks by season.*
cfbd_coaches | *CFBD Coaches Endpoint Overview*
cfbd_coaches_profile | *Get a coach profile*
cfbd_coaches_seasons | *Get coaching seasons*
cfbd_coaches_tenures | *Get coaching tenures*
cfbd_conferences | *CFBD Conferences Endpoint Overview*
cfbd_conference_affiliations | *Get conference affiliations by team and season*
cfbd_conference_changes | *Get conference realignment changes*
cfbd_conf_types_df | *Data in the package for reference*
cfbd_draft | *CFBD NFL Draft Endpoint Overview*
cfbd_draft_picks | *Get list of NFL draft picks*
cfbd_draft_positions | *Get list of NFL positions*
cfbd_draft_teams | *Get list of NFL teams*
cfbd_drives | *CFBD Drives Endpoint Overview*
cfbd_games | *CFBD Games Endpoint Overview*
cfbd_game_box_advanced | *Get game advanced box score information.*
cfbd_game_info | *Get results information from games.*
cfbd_game_media | *Get game media information (TV, radio, etc).*
cfbd_game_player_stats | *Get player statistics by game*
cfbd_game_records | *Get team records by year*
cfbd_game_team_stats | *Get team statistics by game*
cfbd_game_weather | *Get weather from games.*
cfbd_info | *CFBD Info Endpoint Overview*
cfbd_info_usage | *Get API key usage information*
cfbd_key | *CFBD API Key Registration*
cfbd_live_plays | *Get live college football play-by-play data.*
cfbd_live_scoreboard | *Get live game scoreboard information from games.*
cfbd_metrics | *CFBD Metrics Endpoint Overview*
cfbd_metrics_fg_ep | *Get FG expected points from CFBD API*
cfbd_metrics_ppa_games | *Get team game averages for predicted points added (PPA)*
cfbd_metrics_ppa_players_games | *Get player game averages for predicted points added (PPA)*
cfbd_metrics_ppa_players_season | *Get player season averages for predicted points added (PPA)*
cfbd_metrics_ppa_predicted | *Calculate predicted points using down and distance*
cfbd_metrics_ppa_teams | *Get team averages for predicted points added (PPA)*
cfbd_metrics_wepa_players_kicking | *Get Points Added Above Replacement (PAAR) ratings for kickers*
cfbd_metrics_wepa_players_passing | *Get opponent-adjusted player passing statistics for predicted points added (PPA)*
cfbd_metrics_wepa_players_rushing | *Get opponent-adjusted player rushing statistics for predicted points added (PPA)*
cfbd_metrics_wepa_team_season | *Get opponent-adjusted team season statistics for predicted points added (PPA)*
cfbd_metrics_wp | *Get win probability chart data from API*
cfbd_metrics_wp_pregame | *Get pre-game win probability data from API*
cfbd_pbp | *CFBD Play-by-Play Endpoint Overview*
cfbd_pbp_data | *Get college football play by play data with cfbfastR expected points/win probability added*
cfbd_pbp_data_v2 | *Get college football play-by-play data — modular EPA/WPA pipeline (v2)*
cfbd_pbp_v2 | *CFBD Play-by-Play (v2 Modular EPA/WPA Pipeline) Overview*
cfbd_play | *CFBD Plays Endpoint Overview*
cfbd_player | *CFBD Players Endpoint Overview*
cfbd_players | *CFBD Players Endpoint Overview*
cfbd_player_info | *Player information lookup*
cfbd_player_returning | *Get player returning production*
cfbd_player_season_overview | *Get a player season overview*
cfbd_player_usage | *Get player usage metrics*
cfbd_playoffs | *CFBD Playoffs Endpoint Overview*
cfbd_playoffs_cfp | *Get College Football Playoff bracket information*
cfbd_playoffs_cfp_games | *Get College Football Playoff games*
cfbd_playoffs_cfp_participants | *Get College Football Playoff participants*
cfbd_plays | *Get college football play-by-play data.*
cfbd_play_stats_player | *Gets player info associated by play*
cfbd_play_stats_types | *Get college football mapping for play stats types*
cfbd_play_types | *Get college football mapping for play types*
cfbd_play_type_df | *Data in the package for reference*
cfbd_rankings | *Get historical Coaches and AP poll data*
cfbd_ratings | *CFBD Ratings and Rankings Endpoints Overview*
cfbd_ratings_core | *Get core team ratings*
cfbd_ratings_elo | *Get Elo historical rating data*
cfbd_ratings_fpi | *Get Football Power Index (FPI) historical rating data*
cfbd_ratings_sp | *Get SP historical rating data*
cfbd_ratings_sp_conference | *Get conference level SP historical rating data*
cfbd_ratings_srs | *Get SRS historical rating data*
cfbd_ratings_srs_expanded | *Get expanded SRS ratings*
cfbd_recruiting | *CFB Recruiting Endpoint Overview*
cfbd_recruiting_player | *Get player recruiting rankings*
cfbd_recruiting_position | *Get college football position group recruiting information.*
cfbd_recruiting_team | *Get college football recruiting team rankings information.*
cfbd_recruiting_transfer_portal | *Get Transfer Portal Data*
cfbd_stats | *CFBD Stats Endpoint Overview*
cfbd_stats_categories | *Get stats categories*
cfbd_stats_game_advanced | *Get game advanced stats*
cfbd_stats_game_havoc | *Get game havoc statistics*
cfbd_stats_player_success | *Get player success rates by season*
cfbd_stats_player_success_game | *Get player success rates by game*
cfbd_stats_season_advanced | *Get season advanced statistics by team*
cfbd_stats_season_player | *Get season statistics by player*
cfbd_stats_season_team | *Get season statistics by team*
cfbd_teams | *CFBD Teams Endpoint Overview*
cfbd_teams_fbs | *Get FBS teams*
cfbd_team_info | *Team info lookup*
cfbd_team_matchup | *Get matchup history between two teams.*
cfbd_team_matchup_records | *Get matchup history records between two teams.*
cfbd_team_roster | *Get team rosters*
cfbd_team_talent | *Get composite team talent rankings for all teams in a given year*
cfbd_venues | *CFBD Venues Endpoint Overview*
cfp | *CFBD Playoffs Endpoint Overview*
clear_cache | *ESPN College Football Catalog Endpoint Overview*
conferences | *CFBD Conferences Endpoint Overview*
csv_from_url | *Load .csv / .csv.gz file from a remote connection*

## -- D --

data | *Data in the package for reference*
draft | *CFBD NFL Draft Endpoint Overview*

## -- E --

espn_cfb_award | *ESPN College Football Award Detail*
espn_cfb_awards | *ESPN College Football Awards*
espn_cfb_calendar | ESPN Calendar
espn_cfb_catalog | *ESPN College Football Catalog Endpoint Overview*
espn_cfb_clear_cache | *Clear the cfbfastR ESPN catalog cache*
espn_cfb_coach | *ESPN College Football Coach Detail*
espn_cfb_coaches | *ESPN College Football Coaches Index*
espn_cfb_coach_record | *ESPN College Football Coach Season Record*
espn_cfb_franchise | *ESPN College Football Franchise Detail*
espn_cfb_franchises | *ESPN College Football Franchises Index*
espn_cfb_futures | *ESPN College Football Betting Futures (Long Format)*
espn_cfb_game | *ESPN College Football Game Endpoint Overview*
espn_cfb_game_broadcasts | *ESPN College Football Game Broadcasts*
espn_cfb_game_drives | *ESPN College Football Game Drives*
espn_cfb_game_drive_plays | *ESPN College Football Game Drive Plays*
espn_cfb_game_leaders | *ESPN College Football Game Leaders*
espn_cfb_game_odds | *ESPN College Football Game Odds*
espn_cfb_game_pbp | *ESPN College Football Game Plays (Core-v2 Play-by-Play)*
espn_cfb_game_play | *ESPN College Football Game Play (Single Play Detail)*
espn_cfb_game_player_box | *ESPN College Football Game Player Box Score*
espn_cfb_game_player_statistics | *ESPN College Football Game Player Statistics (Single Athlete)*
espn_cfb_game_powerindex | *ESPN College Football Game Power Index (Matchup FPI)*
espn_cfb_game_predictor | *ESPN College Football Game Predictor (BPI Matchup Predictor)*
espn_cfb_game_probabilities | *ESPN College Football Game Win Probabilities*
espn_cfb_game_situation | *ESPN College Football Game Situation*
espn_cfb_game_status | *ESPN College Football Game Status*
espn_cfb_game_teams | *ESPN College Football Game Teams*
espn_cfb_game_team_leaders | *ESPN College Football Game Team Leaders*
espn_cfb_game_team_linescores | *ESPN College Football Game Team Linescores*
espn_cfb_game_team_records | *ESPN College Football Game Team Records*
espn_cfb_game_team_roster | *ESPN College Football Game Team Roster*
espn_cfb_game_team_statistics | *ESPN College Football Game Team Statistics*
espn_cfb_groups | *ESPN College Football Groups & Conferences*
espn_cfb_pbp | Get ESPN college football PBP data
espn_cfb_pbp_v2 | *Get ESPN College Football Play-by-Play (core-v2)*
espn_cfb_player | *ESPN College Football Player Endpoint Overview*
espn_cfb_players | *ESPN College Football Players Index*
espn_cfb_player_career_stats | *ESPN College Football Player Season Statistics (Long Format)*
espn_cfb_player_eventlog | *ESPN College Football Player Event Log*
espn_cfb_player_gamelog | *ESPN College Football Player Game Log*
espn_cfb_player_overview | *ESPN College Football Player Statistics Overview*
espn_cfb_player_seasons | *ESPN College Football Player Seasons*
espn_cfb_player_splits | *ESPN College Football Player Statistical Splits*
espn_cfb_player_stats | *Get ESPN college football player stats data*
espn_cfb_player_stats_v3 | *ESPN College Football Player Stats (web v3, all categories)*
espn_cfb_position | *ESPN College Football Position Detail*
espn_cfb_positions | *ESPN College Football Positions Index*
espn_cfb_powerindex | *ESPN College Football Power Index (Long Format)*
espn_cfb_qbr | *ESPN College Football Total Quarterback Rating (QBR)*
espn_cfb_rankings | *ESPN College Football Ranking Sources*
espn_cfb_recruits | *ESPN College Football Recruits*
espn_cfb_schedule | *ESPN Scoreboard*
espn_cfb_scoreboard | *ESPN Scoreboard*
espn_cfb_season | *ESPN College Football Season Endpoint Overview*
espn_cfb_seasons | *ESPN College Football Seasons Index*
espn_cfb_season_info | *ESPN College Football Season Detail*
espn_cfb_season_types | *ESPN College Football Season Types*
espn_cfb_season_weeks | *ESPN College Football Season Weeks*
espn_cfb_standings | *ESPN College Football Standings (Long Format)*
espn_cfb_team | *ESPN College Football Team Endpoint Overview*
espn_cfb_teams | *ESPN College Football Teams Index*
espn_cfb_team_ats | *ESPN College Football Team Against-the-Spread Records*
espn_cfb_team_awards | *ESPN College Football Team Awards*
espn_cfb_team_coaches | *ESPN College Football Team Coaches*
espn_cfb_team_events | *ESPN College Football Team Season Event Log*
espn_cfb_team_leaders | *ESPN College Football Team Statistical Leaders*
espn_cfb_team_powerindex | *ESPN College Football Single-Team Power Index (Long Format)*
espn_cfb_team_ranks | *ESPN College Football Team Poll Rank History*
espn_cfb_team_record | *ESPN College Football Team Record (Long Format)*
espn_cfb_team_roster | *ESPN College Football Team Roster (Season-Scoped)*
espn_cfb_team_schedule | *ESPN College Football Team Schedule*
espn_cfb_team_stats | *Get ESPN college football team stats data*
espn_cfb_unnest_plays | *Unnest ESPN CFB drive plays into a flat play-by-play table*
espn_cfb_venue | *ESPN College Football Venue Detail*
espn_cfb_venues | *ESPN College Football Venues Index*
espn_cfb_week_rankings | *ESPN College Football Weekly Rankings*
espn_metrics | *ESPN Metrics*
espn_metrics_wp | *ESPN Metrics*
espn_ratings_fpi | *ESPN FPI Ratings*

## -- F --

fox_cfb_boxscore | *Get Fox Sports college football boxscore*
fox_cfb_league_leaders | *Get Fox Sports college football statistical leaders*
fox_cfb_odds | *Get Fox Sports college football game odds*
fox_cfb_pbp | *Get Fox Sports college football play-by-play*
fox_cfb_standings | *Get Fox Sports college football conference standings*
fox_cfb_team_gamelog | *Get Fox Sports college football team game log*
fox_cfb_team_roster | *Get Fox Sports college football team roster*
fox_cfb_team_stats | *Get Fox Sports college football team stat leaders*
franchises | *ESPN College Football Catalog Endpoint Overview*

## -- G --

game | *ESPN College Football Game Endpoint Overview*

## -- H --

has_cfbd_key | *CFBD API Key Registration*

## -- I --

info | *CFBD Info Endpoint Overview*

## -- L --

leaders | *ESPN College Football Game Endpoint Overview*
lines | *CFBD Betting Endpoint Overview*
load_cfb_fpi_weekly | *Load college football weekly ESPN FPI ratings from the SportsDataverse data repo*
load_cfb_pbp | *Load cleaned play-by-play from the data repo*
load_cfb_ratings | *Load college football season power ratings from the SportsDataverse data repo*
load_cfb_ratings_weekly | *Load college football weekly power ratings from the SportsDataverse data repo*
load_cfb_recruiting_proj | *Load college football recruiting projections from the SportsDataverse data repo*
load_cfb_recruits | *Load college football recruiting rankings from the SportsDataverse data repo*
load_cfb_returning_production | *Load college football returning production from the SportsDataverse data repo*
load_cfb_rosters | Load College Football Rosters
load_cfb_rosters_crosswalk | *Load college football roster id crosswalk from the SportsDataverse data repo*
load_cfb_schedules | Load CFB Game/Schedule Data from data repo
load_cfb_schedule_crosswalk | *Load college football schedule id crosswalk from the SportsDataverse data repo*
load_cfb_teams | Load CFB team info from the data repo
load_cfb_teams_crosswalk | *Load college football team id crosswalk from the SportsDataverse data repo*
load_cfb_team_summaries_weekly | *Load college football weekly team summaries from the SportsDataverse data repo*
load_cfb_team_talent | *Load college football team talent composite from the SportsDataverse data repo*
load_espn_cfb_adv_defensive | *Load college football advanced defensive from the SportsDataverse data repo*
load_espn_cfb_adv_defensive_players | *Load college football advanced defensive players from the SportsDataverse data repo*
load_espn_cfb_adv_drives | *Load college football advanced drives from the SportsDataverse data repo*
load_espn_cfb_adv_passing | *Load college football advanced passing from the SportsDataverse data repo*
load_espn_cfb_adv_receiving | *Load college football advanced receiving from the SportsDataverse data repo*
load_espn_cfb_adv_rushing | *Load college football advanced rushing from the SportsDataverse data repo*
load_espn_cfb_adv_situational | *Load college football advanced situational from the SportsDataverse data repo*
load_espn_cfb_adv_specialists | *Load college football advanced specialists from the SportsDataverse data repo*
load_espn_cfb_adv_team | *Load college football advanced team from the SportsDataverse data repo*
load_espn_cfb_adv_team_gamelog | *Load college football advanced team gamelog from the SportsDataverse data repo*
load_espn_cfb_adv_turnover | *Load college football advanced turnover from the SportsDataverse data repo*
load_espn_cfb_betting | *Load ESPN college football betting lines from the SportsDataverse data repo*
load_espn_cfb_drives | *Load ESPN college football drives from the SportsDataverse data repo*
load_espn_cfb_game_rosters | *Load ESPN college football game rosters from the SportsDataverse data repo*
load_espn_cfb_linescores | *Load ESPN college football linescores from the SportsDataverse data repo*
load_espn_cfb_model_pbp | *Load college football model-enriched play-by-play from the SportsDataverse data repo*
load_espn_cfb_passing | *Load college football passing EPA splits from the SportsDataverse data repo*
load_espn_cfb_pbp | *Load ESPN college football play-by-play from the SportsDataverse data repo*
load_espn_cfb_percentiles | *Load college football team percentile profiles from the SportsDataverse data repo*
load_espn_cfb_player_box | *Load ESPN college football player box scores from the SportsDataverse data repo*
load_espn_cfb_play_participants | *Load ESPN college football play participants from the SportsDataverse data repo*
load_espn_cfb_power_index | *Load ESPN college football FPI power index from the SportsDataverse data repo*
load_espn_cfb_receiving | *Load college football receiving EPA splits from the SportsDataverse data repo*
load_espn_cfb_rushing | *Load college football rushing EPA splits from the SportsDataverse data repo*
load_espn_cfb_schedules | *Load ESPN college football schedules from the SportsDataverse data repo*
load_espn_cfb_team_box | *Load ESPN college football team box scores from the SportsDataverse data repo*
load_espn_cfb_team_summaries | *Load college football team season summaries from the SportsDataverse data repo*
load_ncaa_mfb_drives | *Load NCAA men's football drives (stats.ncaa.org) from the SportsDataverse data repo*
load_ncaa_mfb_linescore | *Load NCAA men's football linescores (stats.ncaa.org) from the SportsDataverse data repo*
load_ncaa_mfb_officials | *Load NCAA men's football officials (stats.ncaa.org) from the SportsDataverse data repo*
load_ncaa_mfb_pbp | *Load NCAA men's football play-by-play (stats.ncaa.org) from the SportsDataverse data repo*
load_ncaa_mfb_pbp_cfbfastr | *Load NCAA men's football play-by-play, cfbfastR-shaped from the SportsDataverse data repo*
load_ncaa_mfb_player_stats | *Load NCAA men's football player stats (stats.ncaa.org) from the SportsDataverse data repo*
load_ncaa_mfb_rosters | *Load NCAA men's football rosters (stats.ncaa.org) from the SportsDataverse data repo*
load_ncaa_mfb_schedule | *Load NCAA men's football schedules (stats.ncaa.org) from the SportsDataverse data repo*
load_ncaa_mfb_teams | *Load NCAA men's football teams (stats.ncaa.org) from the SportsDataverse data repo*
load_ncaa_mfb_team_stats | *Load NCAA men's football team stats (stats.ncaa.org) from the SportsDataverse data repo*

## -- M --

min_year_map_df | *Data in the package for reference*
modular_epa | *CFBD Play-by-Play (v2 Modular EPA/WPA Pipeline) Overview*
modular_wpa | *CFBD Play-by-Play (v2 Modular EPA/WPA Pipeline) Overview*

## -- N --

nfl | *CFBD NFL Draft Endpoint Overview*
nfl_draft | *CFBD NFL Draft Endpoint Overview*
nfl_teams | *CFBD NFL Draft Endpoint Overview*

## -- P --

pbp_v2 | *CFBD Play-by-Play (v2 Modular EPA/WPA Pipeline) Overview*
player | *ESPN College Football Player Endpoint Overview*
playoffs | *CFBD Playoffs Endpoint Overview*
plays | *ESPN College Football Game Endpoint Overview*
play_by_play | *CFBD Play-by-Play Endpoint Overview*
positions | *ESPN College Football Catalog Endpoint Overview*

## -- R --

rankings | *ESPN College Football Season Endpoint Overview*
rds_from_url | Load .rds file from a remote connection
recruiting | *CFB Recruiting Endpoint Overview*
recruits | *ESPN College Football Player Endpoint Overview*
register_cfbd | *CFBD API Key Registration*

## -- S --

season | *ESPN College Football Season Endpoint Overview*
seasons | *ESPN College Football Season Endpoint Overview*
spreads | *CFBD Betting Endpoint Overview*
stadiums | *CFBD Venues Endpoint Overview*
standings | *ESPN College Football Season Endpoint Overview*

## -- T --

team | *ESPN College Football Team Endpoint Overview*
team_roster | *ESPN College Football Team Endpoint Overview*
team_schedule | *ESPN College Football Team Endpoint Overview*

## -- U --

update_cfb_db | *Update or create a cfbfastR play-by-play database*
usage | *CFBD Info Endpoint Overview*

## -- Y --

yahoo_cfb_boxscore | *Get Yahoo Sports college football boxscore (SCAFFOLD)*
yahoo_cfb_player_season_stats | *Get Yahoo Sports college football player season stats (modern)*
yahoo_cfb_player_season_stats_legacy | *Get Yahoo Sports CFB legacy per-category player leaders*
yahoo_cfb_scoreboard | *Get Yahoo Sports college football scoreboard*
yahoo_cfb_team_season_stats | *Get Yahoo Sports college football team season stats (modern)*
yahoo_cfb_team_season_stats_legacy | *Get Yahoo Sports CFB legacy per-category team stats*