R/get-team-metadata.R

In euroleaguer: 'Euroleague basketball API'

#' @title Team metadata
#'
#' @keywords teamMetadata
#'
#' @description
#'
#' `r lifecycle::badge('experimental')`
#'
#' Retrieve contextual information about teams.
#' Outputs may be required as arguments of other `getTeam*` or `getPlayer*` functions.
#'
#' @md
#'
#' @inheritParams .inheritParams
#'
#' @return For each function, returns a tibble with information about team,
#' people or games of chosen season and team code.
#'
#' @examples
#'
#' \dontrun{
#'
#' getTeam(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)
#'
#' getTeamPeople(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)
#'
#' getTeamGames(team_code = "ASV", season_code = c("E2023", "E2022")) |> head(5)
#'
#' }


#' @rdname getTeamMetadata
#' @export
getTeam <- function(season_code, team_code){
  .iterate(.getTeam, season_code, team_code)
}

#' @rdname getTeamMetadata
#' @export
getTeamPeople <- function(season_code, team_code){
  .iterate(.getTeamPeople, season_code, team_code)
}

#' @rdname getTeamMetadata
#' @export
getTeamGames <- function(season_code, team_code){
  .iterate(.getTeamGames, season_code, team_code)
}