R/clean_data.R

In KoderKow/twitchr: R Interface for the 'Twitch API'

#' Clean the Response from the Videos Endpoint
#'
#' @param response_content Content from a HTTP Request. This is expecting to take the output from `httr::content()`.
#'
#' @return Clean and tidy tibble.
#' @noRd
clean_videos <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    dplyr::bind_rows() %>%
    date_formatter()

  return_list <- list(
    data = data_clean,
    pagination = response_content$pagination$cursor
  )

  return(return_list)
}

#' Clean the Response From the Clips Endpoint
#'
#' @inheritParams clean_videos
#'
#' @return Clean and tidy tibble.
#' @noRd
clean_clips <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    dplyr::bind_rows() %>%
    date_formatter()

  return_list <- list(
    data = data_clean,
    pagination = response_content$pagination$cursor
  )

  return(return_list)
}

#' Clean the Response From the Clean Bits Cheermotes Endpoint
#'
#' @inheritParams clean_videos
#'
#' @return Clean and tidy tibble.
#' @noRd
clean_bits_cheermotes <- function(response_content) {
  data_raw <-
    response_content %>%
    purrr::pluck("data") %>%
    dplyr::bind_rows()

  tiers_clean <-
    data_raw %>%
    dplyr::pull(tiers) %>%
    purrr::map_dfr(flatten_keep_names) %>%
    dplyr::rename_all(~ glue("tiers_{.x}"))

  data_clean <-
    data_raw %>%
    dplyr::select(-tiers) %>%
    dplyr::bind_cols(tiers_clean) %>%
    date_formatter()

  return(data_clean)
}

#' Clean the Response from Users
#'
#' @inheritParams clean_videos
#'
#' @return Clean and tidy tibble.
#' @noRd
clean_users <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    dplyr::bind_rows() %>%
    dplyr::mutate(created_at = lubridate::ymd_hms(created_at))

  return(data_clean)
}

#' Clean the Response From Games
#'
#' @inheritParams clean_videos
#'
#' @return Clean and tidy tibble.
#' @noRd
clean_games <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    dplyr::bind_rows()

  return(data_clean)
}

#' Clean the Response From Top Games
#'
#' @inheritParams clean_videos
#'
#' @return A named list containing: data, a Clean and tidy tibble. pagination, cursor for pagination.
#' @noRd
clean_top_games <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    dplyr::bind_rows()

  return_list <- list(
    data = data_clean,
    pagination = response_content$pagination$cursor
  )

  return(return_list)
}

#' Clean the Response From Search Channels
#'
#' @inheritParams clean_videos
#'
#' @return A named list containing: data, a Clean and tidy tibble. tags, character vector of current live streamer tags. pagination, cursor for pagination.
#' @noRd
clean_search_channels <- function(response_content) {
  ## Need to iterate after the pluck and remove tag_ids possibly
  data_raw <-
    response_content %>%
    purrr::pluck("data")

  ## Need to get tag names!
  tag_ids <-
    data_raw %>%
    purrr::map(tag_cleaner)

  data_clean <-
    data_raw %>%
    ## Remove tag IDs
    purrr::map_dfr(purrr::discard, is.list)

  return_list <- list(
    data = data_clean,
    tags = tag_ids,
    pagination = response_content$pagination$cursor
  )

  return(return_list)
}

#' Extract and Clean Search Channel Tags
#'
#' @param data_raw_element An element from data_raw/response_content
#'
#' @return A list of tags per searched channel
#' @noRd
tag_cleaner <- function(data_raw_element) {
  clean_tags <-
    data_raw_element %>%
    purrr::keep(is.list) %>%
    unlist(use.names = FALSE)

  return(clean_tags)
}

#' Clean the Response From Search Channels
#'
#' @inheritParams clean_videos
#'
#' @return A named list containing: data, a Clean and tidy tibble. pagination, cursor for pagination.
#' @noRd
clean_get_all_stream_tags <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    purrr::map_dfr(get_all_tags_response_cleaner)

  return_list <- list(
    data = data_clean,
    pagination = response_content$pagination$cursor
  )

  return(return_list)
}

get_all_tags_response_cleaner <- function(data_raw_element) {
  d <-
    dplyr::tibble(
      tag_id = data_raw_element$tag_id,
      is_auto = data_raw_element$is_auto,
      language = names(data_raw_element$localization_names),
      localization_names = unlist(data_raw_element$localization_names, use.names = FALSE),
      localization_descriptions = unlist(data_raw_element$localization_descriptions, use.names = FALSE)
    )

  return(d)
}

#' Clean Stream Tags
#'
#' @inheritParams clean_videos
#' @inheritParams clean_get_all_stream_tags
#'
#' @return Clean and tidy tibble.
#' @noRd
clean_stream_tags <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    purrr::map_dfr(get_all_tags_response_cleaner)

  return(data_clean)
}

#' Clean the Response From Search Categories
#'
#' @inheritParams clean_videos
#'
#' @return A named list containing: data, a Clean and tidy tibble. pagination, cursor for pagination.
#' @noRd
clean_search_categories <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    dplyr::bind_rows()

  return_list <- list(
    data = data_clean,
    pagination = response_content$pagination$cursor
  )

  return(return_list)
}

#' Clean the Response From User Follows
#'
#' @inheritParams clean_videos
#'
#' @return A named list containing: data, a Clean and tidy tibble. pagination, cursor for pagination.
#' @noRd
clean_get_follows <- function(response_content) {
  data_clean <-
    response_content %>%
    purrr::pluck("data") %>%
    dplyr::bind_rows() %>%
    date_formatter()

  return_list <- list(
    data = data_clean,
    pagination = response_content$pagination$cursor
  )

  return(return_list)
}

#' Clean the Response From User Follows
#'
#' @inheritParams clean_videos
#'
#' @return A named list containing: data, a Clean and tidy tibble. vacation, if not `NULL`, a clean and tidy tibble. pagination, cursor for pagination.
#' @noRd
clean_get_schedule <- function(response_content) {
  response_data <-
    response_content %>%
    purrr::pluck("data")

  ## Get the segements
  if (is.null(response_data$segments)) {
    d_final <- NULL
  } else {
    initial_segments <-
      response_data$segments %>%
      purrr::map(~ purrr::map(.x, ~ .x %||% NA)) %>%
      dplyr::bind_rows() %>%
      tidyr::unnest(category)

    d_final <-
      initial_segments %>%
      dplyr::mutate(category_type = rep(c("category_id", "category_name"), nrow(initial_segments) / 2)) %>%
      tidyr::pivot_wider(
        names_from = category_type,
        values_from = category
      ) %>%
      dplyr::mutate(
        category_id       = as.numeric(category_id),
        broadcaster_id    = response_data$broadcaster_id,
        broadcaster_name  = response_data$broadcaster_name,
        broadcaster_login = response_data$broadcaster_login
      ) %>%
      dplyr::relocate(dplyr::starts_with("broadcaster_")) %>%
      date_formatter()
  }

  ## Check for vacation
  if (!is.null(response_data$vacation)) {
    d_vacation <-
      dplyr::tibble(
        broadcaster_id    = response_data$broadcaster_id,
        broadcaster_name  = response_data$broadcaster_name,
        broadcaster_login = response_data$broadcaster_login,
        start_time        = response_data$vacation$start_time,
        end_time          = response_data$vacation$end_time
      ) %>%
      date_formatter()
  } else {
    d_vacation <- NULL
  }

  return_list <- list(
    data = d_final,
    vacation = d_vacation,
    pagination = response_content$pagination$cursor
  )

  return(return_list)
}