Skip to contents

Get pre-game win probability data from API

Usage

cfbd_metrics_wp_pregame(
  year = NULL,
  week = NULL,
  team = NULL,
  season_type = "regular"
)

Arguments

year

(Integer optional): Year, 4 digit format (YYYY)

week

(Integer optional): Week - values from 1-15, 1-14 for seasons pre-playoff, i.e. 2013 or earlier

team

(String optional): D-I Team

season_type

(String default regular): Select Season Type: regular or postseason

Value

cfbd_metrics_wp_pregame() - A data frame with 9 variables:

season: integer.

Season of game.

season_type: character.

Season type of game.

week: integer.

Game week of the season.

game_id: integer.

Referencing game id.

home_team: character.

Home team name.

away_team: character.

Away team name.

spread: integer.

Betting line provider spread.

home_win_prob: double.

Home win probability - pre-game prediction.

away_win_prob: double.

Away win probability - pre-game prediction.

Examples

# \donttest{
  try(cfbd_metrics_wp_pregame(year = 2019, week = 9, team = "Texas A&M"))
#> ── pre-game WP data from CollegeFootballData.com ───────────── cfbfastR 1.9.3 ──
#>  Data updated: 2022-09-23 03:23:18 UTC
#> # A tibble: 1 × 9
#>   season season_type  week   game_id home_team away_team  spread home_…¹ away_…²
#>    <int> <chr>       <int>     <int> <chr>     <chr>       <int>   <dbl>   <dbl>
#> 1   2019 regular         9 401110835 Texas A&M Mississip…    -11   0.776   0.224
#> # … with abbreviated variable names ¹​home_win_prob, ²​away_win_prob
# }