Skip to contents

Returns pregame team comparisons and key players. Analysis remains available until the game is completed. Team statistics may use the previous season; players and context stay in the game season.

Usage

cfbd_game_preview(game_id, proxy = NULL)

Arguments

game_id

(Integer required): Game ID filter for querying a single game. Can be found using the cfbd_game_info() or cfbd_game_schedule() functions.

proxy

(List optional): Per-call proxy override passed to get_req(). NULL (default) falls back to getOption("cfbfastR.proxy") and then the http(s)_proxy environment variables.

Value

A named list of data frames: game, broadcasts, odds, teams, key_players, recent_results, series, series_meetings. The sections have different row grains, so they are not joined. A section CFBD did not fill is a 0-column tibble: once availability is metadata_only (for example a completed game) every section except game is empty. Nested objects are flattened into prefixed columns, and a nested object CFBD sends as null (venue, playoff, latest_meeting, streak, a statistics block) becomes one all-NA column named after it instead of its prefixed columns. An empty list is returned if the request fails.

game - one row:

col_nametypedescription
game_idintegerUnique CFBD game identifier.
seasonintegerSeason of the game.
weekintegerGame week (postseason games restart at week 1).
season_typecharacterSeason type of the game (e.g. regular, postseason).
statuscharacterGame status: scheduled, in_progress or completed.
status_checked_atcharacterWhen CFBD last checked the game status (ISO 8601, UTC).
start_datecharacterGame start date-time (ISO 8601, UTC).
start_time_tbdlogicalTRUE if the start time is still to be determined.
neutral_sitelogicalTRUE if the game is at a neutral site.
conference_gamelogicalTRUE if the game is a conference game.
home_team_idintegerHome team id.
home_team_namecharacterHome team name.
home_team_conferencecharacterHome team conference.
home_team_conference_abbreviationcharacterHome team conference abbreviation.
home_team_classificationcharacterHome team division classification: fbs, fcs, ii, ii/iii or iii.
home_team_pointsintegerHome team points; NA until the game has a score.
away_team_idintegerAway team id.
away_team_namecharacterAway team name.
away_team_conferencecharacterAway team conference.
away_team_conference_abbreviationcharacterAway team conference abbreviation.
away_team_classificationcharacterAway team division classification: fbs, fcs, ii, ii/iii or iii.
away_team_pointsintegerAway team points; NA until the game has a score.
venue_idintegerVenue id.
venue_namecharacterVenue name.
venue_citycharacterVenue city.
venue_statecharacterVenue state abbreviation.
playofflogicalAll-NA placeholder, present only when the game is not a College Football Playoff game (the eight playoff_* columns replace it for CFP games).
playoff_competitioncharacterPlayoff competition (cfp); present only for CFP games.
playoff_formatcharacterPlayoff format (e.g. twelve_team_2025); present only for CFP games.
playoff_roundcharacterPlayoff round: first_round, quarterfinal, semifinal or championship; present only for CFP games.
playoff_round_namecharacterDisplay name of the round (e.g. Quarterfinal); present only for CFP games.
playoff_bracket_slotcharacterBracket slot code (e.g. FR4, QF1); present only for CFP games.
playoff_home_seedintegerHome team playoff seed; present only for CFP games.
playoff_away_seedintegerAway team playoff seed; present only for CFP games.
playoff_bowl_namecharacterName of the bowl hosting the game (e.g. Rose Bowl), NA when none; present only for CFP games.
availabilitycharacterpregame (analysis sections filled) or metadata_only (only game is filled).
reasoncharacterWhy analysis is not available: game_started, game_completed, kickoff_reached or kickoff_unknown; NA when availability is pregame.
assembled_atcharacterWhen CFBD assembled the preview (ISO 8601, UTC).

broadcasts - one row per broadcast:

col_nametypedescription
media_typecharacterBroadcast medium: tv, radio, web, ppv or mobile.
outletcharacterBroadcast outlet (e.g. ABC).

odds - one row, the line from the selected sportsbook:

col_nametypedescription
provider_idintegerSportsbook provider id.
providercharacterSportsbook: DraftKings or Bovada.
spreaddoubleHome-relative point spread; negative favors home. Integer when every spread in the result is a whole number.
over_underdoubleTotal points line.
home_moneylineintegerHome team moneyline (American odds).
away_moneylineintegerAway team moneyline (American odds).

teams - one row per side (home, away). The rows ppa through field_position_average_predicted_points (metrics) and rank through percentile (stats) are base names: each metric appears as the columns statistics_data_stat_rankings_<side>_<metric>_<stat>, for <side> offense then defense, every metric in row order and every stat in row order (160 columns), except that a metric CFBD sends as null (in the sample, power_success) is one all-NA statistics_data_stat_rankings_<side>_<metric> column instead of four:

col_nametypedescription
sidecharacterhome or away: which team of this game the row describes.
team_idintegerTeam id.
seasonintegerSeason of the game.
statistics_statuscharacterStatus of the team statistics section: available, no_data or unavailable.
statistics_reasoncharacterWhy the statistics section has no data: no_data, no_results_yet, source_error or invalid_data; NA when available.
statistics_assembled_atcharacterWhen CFBD assembled the statistics section (ISO 8601, UTC).
statistics_source_updated_atcharacterPublication time of the statistics snapshot, not a games-through cutoff (ISO 8601, UTC).
statistics_data_seasonintegerSeason the team statistics come from.
statistics_data_is_previous_seasonlogicalTRUE when the statistics come from the season before the game season.
statistics_data_advanced_*variesThe advanced section of cfbd_team_season_overview() for statistics_data_season (same columns and order), prefixed statistics_data_advanced_; each column is defined there.
statistics_data_passing_*variesAll columns of cfbd_passing_teams_season(), including season, team and conference, in the order of the passing section of cfbd_team_season_overview(), prefixed statistics_data_passing_; each column is defined there, see cfbd_passing.
statistics_data_rushing_*variesAll columns of cfbd_rushing_teams_season(), including season, team and conference, in the order of the rushing section of cfbd_team_season_overview(), prefixed statistics_data_rushing_; each column is defined there, see cfbd_rushing.
statistics_data_stat_rankings_team_idintegerTeam id the stat rankings are for.
statistics_data_stat_rankings_seasonintegerSeason the stat rankings are computed for.
statistics_data_stat_rankings_divisioncharacterDivision the team is ranked within: fbs, fcs, ii, ii/iii or iii.
statistics_data_stat_rankings_division_team_countintegerNumber of teams in that division.
statistics_data_stat_rankings_calculated_atcharacterWhen CFBD calculated the stat rankings (ISO 8601, UTC).
statistics_data_stat_rankings_expires_atcharacterWhen CFBD's cached stat rankings expire (ISO 8601, UTC).
statistics_data_stat_rankings_source_updated_atcharacterPublication time of the statistics the rankings are built from (ISO 8601, UTC).
ppavariesMetric: predicted points added (EPA) per play, statistics_data_advanced_<side>_ppa.
success_ratevariesMetric: success rate (proportion of successful plays), statistics_data_advanced_<side>_success_rate.
explosivenessvariesMetric: explosiveness (average PPA on successful plays), statistics_data_advanced_<side>_explosiveness.
standard_downs_success_ratevariesMetric: success rate on standard downs, statistics_data_advanced_<side>_standard_downs_success_rate.
passing_downs_success_ratevariesMetric: success rate on passing downs, statistics_data_advanced_<side>_passing_downs_success_rate.
passing_plays_ppavariesMetric: PPA per pass play, statistics_data_advanced_<side>_passing_plays_ppa.
rushing_plays_ppavariesMetric: PPA per rush play, statistics_data_advanced_<side>_rushing_plays_ppa.
passing_plays_explosivenessvariesMetric: explosiveness of pass plays, statistics_data_advanced_<side>_passing_plays_explosiveness.
rushing_plays_explosivenessvariesMetric: explosiveness of rush plays, statistics_data_advanced_<side>_rushing_plays_explosiveness.
line_yardsvariesMetric: offensive line yards per rush, statistics_data_advanced_<side>_line_yards.
second_level_yardsvariesMetric: second-level yards per rush (5-10 yards past the line of scrimmage), statistics_data_advanced_<side>_second_level_yards.
open_field_yardsvariesMetric: open-field yards per rush (yards gained more than 10 yards past the line of scrimmage), statistics_data_advanced_<side>_open_field_yards.
stuff_ratevariesMetric: proportion of rushes stopped at or behind the line of scrimmage, statistics_data_advanced_<side>_stuff_rate.
power_successvariesMetric: power success (proportion of short-yardage runs that convert), statistics_data_advanced_<side>_power_success.
havoc_totalvariesMetric: havoc rate (share of plays with a tackle for loss, forced fumble, interception or pass breakup), statistics_data_advanced_<side>_havoc_total.
havoc_front_sevenvariesMetric: havoc rate from front-seven players, statistics_data_advanced_<side>_havoc_front_seven.
havoc_dbvariesMetric: havoc rate from defensive backs, statistics_data_advanced_<side>_havoc_db.
points_per_opportunityvariesMetric: points per scoring opportunity, statistics_data_advanced_<side>_points_per_opportunity.
field_position_average_startvariesMetric: average drive start in yards to the end zone, statistics_data_advanced_<side>_field_position_average_start.
field_position_average_predicted_pointsvariesMetric: average predicted points of the drive start, statistics_data_advanced_<side>_field_position_average_predicted_points.
rankintegerStat: the team's rank on the metric within statistics_data_stat_rankings_division, 1 = best for that side of the ball.
populationintegerStat: number of teams ranked on the metric.
tiedlogicalStat: TRUE when the rank is shared with another team.
percentiledoubleStat: percentile of the rank within the division, 0-100 (higher is better).
record_statuscharacterStatus of the record section: available, no_data or unavailable.
record_reasoncharacterWhy the record section has no data: no_data, no_results_yet, source_error or invalid_data; NA when available.
record_assembled_atcharacterWhen CFBD assembled the record section (ISO 8601, UTC).
record_source_updated_atcharacterPublication time of the record snapshot (ISO 8601, UTC); NA when CFBD reports none.
record_data_*variesThe record section of cfbd_team_season_overview(), prefixed record_data_; each column is defined there.
ratings_statuscharacterStatus of the ratings section: available, no_data or unavailable.
ratings_reasoncharacterWhy the ratings section has no data: no_data, no_results_yet, source_error or invalid_data; NA when available.
ratings_assembled_atcharacterWhen CFBD assembled the ratings section (ISO 8601, UTC).
ratings_source_updated_atcharacterPublication time of the ratings snapshot (ISO 8601, UTC); NA when CFBD reports none.
ratings_data_*variesThe ratings section of cfbd_team_season_overview() (the same padded, typed 25 columns), prefixed ratings_data_; each column is defined there. Absent when the ratings section has no data.

key_players - one row per key player, per side and category:

col_nametypedescription
sidecharacterhome or away.
categorycharacterpassing, rushing or receiving.
athlete_idcharacterPlayer id.
namecharacterPlayer name.
positioncharacterPlayer position.
usagedoublePass/rush involvement (proportion 0-1), not receiving target share.
average_ppadoubleAverage predicted points added per play.
total_ppadoubleTotal predicted points added.

recent_results - one row per recent game of each side:

col_nametypedescription
sidecharacterhome or away: the team of this game the result belongs to.
game_idintegerGame id of the recent game.
seasonintegerSeason of the recent game.
start_datecharacterStart date-time of the recent game (ISO 8601, UTC).
home_awaycharacterWhether the side's team was home or away in that game.
neutral_sitelogicalTRUE if that game was at a neutral site.
team_pointsintegerPoints scored by the side's team; NA when unknown.
opponent_pointsintegerPoints scored by the opponent; NA when unknown.
resultcharacterResult for the side's team: win, loss, tie or unknown.
opponent_idintegerOpponent team id.
opponent_namecharacterOpponent team name.
venue_idintegerVenue id.
venue_namecharacterVenue name.
venue_citycharacterVenue city.
venue_statecharacterVenue state abbreviation.

series - one row, the all-time series between the two teams:

col_nametypedescription
home_team_idintegerTeam id of this game's home team.
away_team_idintegerTeam id of this game's away team.
meetingsintegerNumber of all-time meetings.
known_resultsintegerMeetings with a known result.
unknown_resultsintegerMeetings with an unknown result.
home_winsintegerSeries wins by this game's home team, wherever played.
away_winsintegerSeries wins by this game's away team, wherever played.
tiesintegerTied meetings.
first_seasonintegerSeason of the first meeting; NA when the teams have not met.
last_seasonintegerSeason of the most recent meeting; NA when the teams have not met.
latest_meeting_game_idintegerGame id of the most recent meeting.
latest_meeting_seasonintegerSeason of the most recent meeting.
latest_meeting_start_datecharacterStart date-time of the most recent meeting (ISO 8601, UTC).
latest_meeting_home_team_idintegerHome team id in the most recent meeting.
latest_meeting_home_teamcharacterHome team name in the most recent meeting.
latest_meeting_away_team_idintegerAway team id in the most recent meeting.
latest_meeting_away_teamcharacterAway team name in the most recent meeting.
latest_meeting_neutral_sitelogicalTRUE if the most recent meeting was at a neutral site.
latest_meeting_venue_idintegerVenue id of the most recent meeting.
latest_meeting_venue_namecharacterVenue name of the most recent meeting.
latest_meeting_venue_citycharacterVenue city of the most recent meeting.
latest_meeting_venue_statecharacterVenue state abbreviation of the most recent meeting.
latest_meeting_home_pointsintegerHome team points in the most recent meeting.
latest_meeting_away_pointsintegerAway team points in the most recent meeting.
latest_meeting_winner_team_idintegerWinning team id in the most recent meeting; NA for a tie or unknown result.
latest_meeting_resultcharacterResult of the most recent meeting: win (see winner id), tie or unknown.
streak_team_idintegerTeam id holding the current series winning streak.
streak_winsintegerLength of that winning streak, in consecutive meetings won.

series_meetings - one row per recent meeting of the two teams:

col_nametypedescription
game_idintegerGame id of the meeting.
seasonintegerSeason of the meeting.
start_datecharacterStart date-time of the meeting (ISO 8601, UTC).
home_team_idintegerHome team id in the meeting.
home_teamcharacterHome team name in the meeting.
away_team_idintegerAway team id in the meeting.
away_teamcharacterAway team name in the meeting.
neutral_sitelogicalTRUE if the meeting was at a neutral site.
home_pointsintegerHome team points; NA when unknown.
away_pointsintegerAway team points; NA when unknown.
winner_team_idintegerWinning team id; NA for a tie or unknown result.
resultcharacterResult of the meeting: win (see winner_team_id), tie or unknown.
venue_idintegerVenue id.
venue_namecharacterVenue name.
venue_citycharacterVenue city.
venue_statecharacterVenue state abbreviation.

Examples

# \donttest{
  try(cfbd_game_preview(game_id = 401114233))
#> $game
#> ── Game preview data from CollegeFootballData.com ─────── cfbfastR 3.0.0.9000 ──
#> ℹ Data updated: 2026-10-12 12:59:11 UTC
#> # A tibble: 1 × 30
#>     game_id season  week season_type status    status_checked_at      start_date
#>       <int>  <int> <int> <chr>       <chr>     <chr>                  <chr>     
#> 1 401114233   2019     1 regular     completed 2026-10-12T12:59:10.1… 2019-08-3…
#> # ℹ 23 more variables: start_time_tbd <lgl>, neutral_site <lgl>,
#> #   conference_game <lgl>, home_team_id <int>, home_team_name <chr>,
#> #   home_team_conference <chr>, home_team_conference_abbreviation <chr>,
#> #   home_team_classification <chr>, home_team_points <int>, away_team_id <int>,
#> #   away_team_name <chr>, away_team_conference <chr>,
#> #   away_team_conference_abbreviation <chr>, away_team_classification <chr>,
#> #   away_team_points <int>, venue_id <int>, venue_name <chr>, …
#> 
#> $broadcasts
#> ── Game preview data from CollegeFootballData.com ─────── cfbfastR 3.0.0.9000 ──
#> ℹ Data updated: 2026-10-12 12:59:11 UTC
#> # A tibble: 0 × 0
#> 
#> $odds
#> ── Game preview data from CollegeFootballData.com ─────── cfbfastR 3.0.0.9000 ──
#> ℹ Data updated: 2026-10-12 12:59:11 UTC
#> # A tibble: 0 × 0
#> 
#> $teams
#> ── Game preview data from CollegeFootballData.com ─────── cfbfastR 3.0.0.9000 ──
#> ℹ Data updated: 2026-10-12 12:59:11 UTC
#> # A tibble: 0 × 0
#> 
#> $key_players
#> ── Game preview data from CollegeFootballData.com ─────── cfbfastR 3.0.0.9000 ──
#> ℹ Data updated: 2026-10-12 12:59:11 UTC
#> # A tibble: 0 × 0
#> 
#> $recent_results
#> ── Game preview data from CollegeFootballData.com ─────── cfbfastR 3.0.0.9000 ──
#> ℹ Data updated: 2026-10-12 12:59:11 UTC
#> # A tibble: 0 × 0
#> 
#> $series
#> ── Game preview data from CollegeFootballData.com ─────── cfbfastR 3.0.0.9000 ──
#> ℹ Data updated: 2026-10-12 12:59:11 UTC
#> # A tibble: 0 × 0
#> 
#> $series_meetings
#> ── Game preview data from CollegeFootballData.com ─────── cfbfastR 3.0.0.9000 ──
#> ℹ Data updated: 2026-10-12 12:59:11 UTC
#> # A tibble: 0 × 0
#> 
# }