R/read_data.R

In fjodor/tsortmusicr: Functions to Work with Data from https://tsort.info/ - The World's Music Charts

###########################################################################################
#' Importing Full Data from tsort.info
#'
#' \code{tsm_read_chart} reads the complete set of data published at \url{https://tsort.info}.
#' A wrapper for readr::read_csv with convenient defaults, see parameters.
#'
#' Note that usage of data from tsort.info is free under the following conditions:
#'
#' 1. Acknowledge the source.
#'
#' 2. Prominently link to \url{https://tsort.info}
#'
#' 3. Always include version number.
#'
#' @family read functions
#'
#' @param version The version in string format. Defaults to function reading the current version from tsort.info. Example: "2-8-0025".
#' @param na How unknown years are encoded, in string format.
#' @param tsort_path URL to Website.
#' @param ... Pass additional parameters to readr::read_csv. See ?read_csv for details.
#' @return A tibble (and data.frame) created from readr::read_csv.
#' @return Additional attribute: file version. Access it: attr(data, "version")
#' @examples
#' \dontrun{
#' ## Read full data; this takes a while to run
#' chart <- tsm_read_chart()
#'
#' ## Using additional parameter from readr::read_csv
#' ## Extract only first 1000 rows of data
#' chart <- tsm_read_chart(n_max = 1000)
#'
#' ## Access file version number:
#' attr(chart, "version")
#' }
#' @export
#'
tsm_read_chart <- function(version = tsm_get_version(),
                       na = "unknown",
                       tsort_path = "https://tsort.info/",
                       ...) {
  data <- readr::read_csv(paste0(tsort_path, "tsort-chart-", version),
                  na = c("", "NA", na), ...)
  attr(data, "version") <- version
  attr(data, "spec") <- NULL
  data
}

#'

# test <- read_chart()

# test <- read_chart(version = "3")
# Error handling


###########################################################################################
#' Importing Song Data from tsort.info
#'
#' \code{tsm_read_songs} reads the top 5000 songs.
#' A wrapper for readr::read_csv with convenient defaults, see parameters.
#'
#' Note that usage of data from tsort.info is free under the following conditions:
#'
#' 1. Acknowledge the source.
#'
#' 2. Prominently link to \url{https://tsort.info}
#'
#' 3. Always include version number.
#'
#' @family read functions
#' @inheritParams tsm_read_chart
#' @examples
#' \dontrun{
#' ## Read Top 5000 songs
#' songs <- tsm_read_songs()
#'
#' ## Access file version number:
#' attr(songs, "version")
#'}
#' @export

tsm_read_songs <- function(version = tsm_get_version(),
                           na = "unknown",
                           tsort_path = "https://tsort.info/csv/",
                           ...)      {
  data <- readr::read_csv(paste0(tsort_path, "top5000songs-", version),
                  na = c("", "NA", na), ...)
  attr(data, "version") <- version
  attr(data, "spec") <- NULL
  data
}


###########################################################################################
#' Importing Album Data from tsort.info
#'
#' \code{tsm_read_albums} reads the top 3000 albums.
#' A wrapper for readr::read_csv with convenient defaults, see parameters.
#'
#' Note that usage of data from tsort.info is free under the following conditions:
#'
#' 1. Acknowledge the source.
#'
#' 2. Prominently link to \url{https://tsort.info}
#'
#' 3. Always include version number.
#'
#' @family read functions
#' @inheritParams tsm_read_chart
#' @examples
#' \dontrun{
#' ## Read Top 3000 albums
#' albums <- tsm_read_albums()
#'
#' ## Access file version number:
#' attr(albums, "version")
#'}
#' @export

tsm_read_albums <- function(version = tsm_get_version(),
                           na = "unknown",
                           tsort_path = "https://tsort.info/csv/",
                           ...)      {
  data <- readr::read_csv(paste0(tsort_path, "top3000albums-", version),
                          na = c("", "NA", na), ...)
  attr(data, "version") <- version
  attr(data, "spec") <- NULL
  data
}


########################################################################
#' Get current file version number
#'
#' \code{tsm_get_version} Extracts the current file version used at \url{https://tsort.info}.
#'
#' Note that usage of data from tsort.info is free under the following conditions:
#'
#' 1. Acknowledge the source.
#'
#' 2. Prominently link to \url{https://tsort.info}
#'
#' 3. Always include version number.
#'
#' @family read functions
#' @param url Website containing information on version numbers.
#' @examples
#' ## Get current file version.
#' tsm_get_version()
#' @export

tsm_get_version <- function(url = "https://tsort.info/music/faq_version_numbers.htm") {
  version <- httr::GET(url)
  version <- httr::content(version, "text", encoding = "UTF-8")
  start <- stringi::stri_locate_first(version, fixed = "CSV File: tsort-chart-")[1, 2] + 1
  suchtext <- substr(x = version, start = start, stop = start + 14)
  end <- stringi::stri_locate_first(suchtext, fixed = ".csv")[1, 1] - 1
  version <- substr(x = version, start = start, stop = start + end - 1)
  version
  # list(version = version, start = start, end = end, suchtext = suchtext)
}