R/espn_wnba_news.R

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

#' **Get ESPN WNBA News**
#' @name espn_wnba_news
NULL
#' @title
#' **Get ESPN WNBA News**
#' @rdname espn_wnba_news
#' @author Saiem Gilani
#' @param limit integer. Maximum number of articles to return. Default `50`.
#' @return Returns a tibble of news articles.
#'
#'    Columns as documented in the shared [espn_basketball_news_schema] table.
#'
#' @importFrom jsonlite fromJSON
#' @importFrom dplyr select as_tibble
#' @importFrom janitor clean_names
#' @import rvest
#' @export
#' @family ESPN WNBA Functions
#' @details
#' Retrieve ESPN WNBA news. Uses `getOption("wehoop.proxy")` or
#' `http_proxy`/`https_proxy` environment variables for proxy configuration
#' (per-call proxy override is not supported for ESPN wrappers).
#' @examples
#' \donttest{
#'   espn_wnba_news(limit = 5)
#' }
espn_wnba_news <- function(limit = 50) {
  .args <- mget(setdiff(names(formals()), "..."))
  .espn_basketball_news(league = "wnba", limit = limit)
}


#' **Get ESPN WNBA Team News**
#' @name espn_wnba_team_news
NULL
#' @title
#' **Get ESPN WNBA Team News**
#' @rdname espn_wnba_team_news
#' @author Saiem Gilani
#' @param team_id character or integer. ESPN team ID (e.g. `17` for
#'   Las Vegas Aces).
#' @param limit integer. Maximum number of articles to return. Default `25`.
#' @return Returns a tibble of team news articles.
#'
#'    Columns as documented in the shared [espn_basketball_news_schema] table.
#'
#' @importFrom jsonlite fromJSON
#' @importFrom dplyr select as_tibble
#' @importFrom janitor clean_names
#' @import rvest
#' @export
#' @family ESPN WNBA Functions
#' @details
#' Retrieve ESPN WNBA news for a specific team. Uses
#' `getOption("wehoop.proxy")` or `http_proxy`/`https_proxy` environment
#' variables for proxy configuration (per-call proxy override is not
#' supported for ESPN wrappers).
#' @examples
#' \donttest{
#'   espn_wnba_team_news(team_id = "17", limit = 5)
#' }
espn_wnba_team_news <- function(team_id, limit = 25) {
  .args <- mget(setdiff(names(formals()), "..."))
  .espn_basketball_team_news(
    league  = "wnba",
    team_id = team_id,
    limit   = limit
  )
}