R/ratings.R

In bushtucker: 'I'm a Celebrity Get Me Out of Here' Data

#' IACGMOOH ratings data
#'
#' Data on TV viewership and ratings for the first 24 seasons of the
#' UK TV show "I'm A Celebrity, Get Me Out Of Here". Viewership and rankings
#' data is linked on the season wikipedia pages but comes from BARB ratings
#' for each week.
#'
#' @format ## `ratings`
#' A data frame with 458 rows and 6 columns:
#' \describe{
#'   \item{season}{(\emph{numeric}) Season of the show}
#'   \item{episode}{(\emph{numeric}) Episode of the season}
#'   \item{date}{(\emph{Date}) Date the episode was aired}
#'   \item{viewership_millions}{(\emph{numeric}) The total reported viewership
#'   for the episode in millions, including on ITV HD and ITV+1 where available}
#'   \item{weekly_uk_tv_rank}{(\emph{numeric}) Available for seasons 1-9, this
#'   is where the episode ranked among all shows on UK TV that week}
#'   \item{weekly_itv_rank}{(\emph{numeric}) Available for seasons 10-24, this
#'   is where the episode ranked among all shows on ITV that week}
#' }
#' @inherit contestants source
#' @source https://www.barb.co.uk/viewing-data/weekly-top-30/
#' @examples{
#' # Which was the least viewed episode ever?
#' ratings[which.min(ratings$viewership_millions), c("season", "episode", "viewership_millions")]
#'
#' # Which was the most viewed episode ever?
#' ratings[which.max(ratings$viewership_millions), c("season", "episode", "viewership_millions")]
#' }
"ratings"