R/espn_wnba_powerindex.R

In wehoop: Access Women's Basketball Play by Play Data

# espn_wnba_powerindex.R

#' **Get ESPN WNBA Season Power Index (Long Format)**
#' @name espn_wnba_powerindex
NULL
#' @title
#' **Get ESPN WNBA Season Power Index (Long Format)**
#' @rdname espn_wnba_powerindex
#' @author Saiem Gilani
#' @description
#' Returns ESPN's Basketball Power Index (BPI) and related per-team
#' metrics for one WNBA season, in long format: one row per (team x stat).
#'
#' @param season Season year (numeric). Defaults to the most recent WNBA season.
#' @param season_type Integer (1=preseason, 2=regular (default), 3=postseason).
#' @param ... Additional arguments; currently unused.
#' @return A long tibble with one row per (team x stat).
#'
#'    \if{html}{\tabular{lll}{
#'       col_name \tab types \tab description \cr
#'       league \tab character \tab League slug (\code{"wnba"}). \cr
#'       season \tab integer \tab Season year. \cr
#'       season_type \tab integer \tab 1=preseason, 2=regular, 3=postseason. \cr
#'       team_id \tab character \tab ESPN team id. \cr
#'       stat_name \tab character \tab Internal stat key. \cr
#'       abbreviation \tab character \tab Short stat abbreviation. \cr
#'       display_name \tab character \tab Human-readable stat name. \cr
#'       description \tab character \tab Stat description. \cr
#'       value \tab numeric \tab Stat value. \cr
#'       display_value \tab character \tab Display-formatted value. \cr
#'       last_updated \tab character \tab Last-updated timestamp. \cr
#'       team_ref \tab character \tab \verb{$ref} to the team-in-season resource. \cr
#'    }}
#'    \if{latex}{See the HTML help or pkgdown reference for the column table.}
#'
#' @importFrom jsonlite fromJSON
#' @importFrom dplyr as_tibble
#' @export
#' @family ESPN WNBA Functions
#' @examples
#' \donttest{
#'   espn_wnba_powerindex(season = 2025)
#' }
espn_wnba_powerindex <- function(season = most_recent_wnba_season(),
                                  season_type = c(2L, 3L), ...) {
  .espn_basketball_powerindex(league = "wnba", season = season,
                                season_type = season_type, ...)
}