R/get_channel_stats.R

In soodoku/tuber: Client for the YouTube API

#' Get statistics of a Channel
#'
#' @param channel_id Character. Id of the channel
#' @param mine Boolean. TRUE if you want to fetch stats of your own channel. Default is NULL.
#' @param \dots Additional arguments passed to \code{\link{tuber_GET}}.
#'
#' @return nested named list with top element names:
#' \code{kind, etag, id, snippet (list of details of the channel
#' including title), statistics (list of 5)}
#'
#' If the \code{channel_id} is mistyped or there is no information, an empty list is returned
#'
#' @export
#'
#' @references \url{https://developers.google.com/youtube/v3/docs/channels/list}
#'
#' @examples
#' \dontrun{
#'
#' # Set API token via yt_oauth() first
#'
#' get_channel_stats(channel_id="UCMtFAi84ehTSYSE9XoHefig")
#' get_channel_stats(channel_id="UCMtFAi84ehTSYSE9Xo") # Incorrect channel ID
#' }

get_channel_stats <- function(channel_id = NULL, mine = NULL, ...) {
  
  if (identical(tolower(mine), "false")) {
    mine <- NULL
  }
  
  if (!is.character(channel_id) && !identical(tolower(mine), "true")) {
    stop("Must specify a channel ID or set mine = 'true'.")
  }
  
  querylist <- list(part = "statistics,snippet", id = channel_id, mine = mine)
  
  raw_res <- tuber_GET("channels", querylist, ...)
  
  if (length(raw_res$items) == 0) {
    warning("No channel stats available. Likely cause: Incorrect channel_id.\n")
    return(list())
  }
  
  res <- raw_res$items[[1]]
  res_stats <- res$statistics
  res_snippet <- res$snippet
  
  cat("Channel Title:", res_snippet$title, "\n")
  cat("No. of Views:", res_stats$viewCount, "\n")
  cat("No. of Subscribers:", res_stats$subscriberCount, "\n")
  cat("No. of Videos:", res_stats$videoCount, "\n")
  
  res
}

#' @rdname get_channel_stats
#' @export
list_my_channel <- function(...) {
  
  querylist <- list(part = "snippet,contentDetails,statistics", mine = "true")
  
  raw_res <- tuber_GET("channels", querylist, ...)
  
  if (length(raw_res$items) == 0) {
    warning("No channel stats available. Likely cause: No videos.\n")
    return(list())
  }
  
  res <- raw_res$items[[1]]
  res_stats <- res$statistics
  res_snippet <- res$snippet
  
  cat("Channel Title:", res_snippet$title, "\n")
  cat("No. of Views:", res_stats$viewCount, "\n")
  cat("No. of Subscribers:", res_stats$subscriberCount, "\n")
  cat("No. of Videos:", res_stats$videoCount, "\n")
  
  res
}