R/getunz.R

In hmsidwR: Health Metrics and the Spread of Infectious Diseases

#' Download, Unzip and Read Data: getunz
#'
#' @param url A url string for a .zip file.
#'
#' @return A dataframe object from a zipped file.
#' Particulary useful For downloading data from IHME GBD Results: "https://vizhub.healthdata.org/gbd-results/".
#' The function takes the url, creates a temp directory,
#' unzip the file, if more than one csv files is available, it lists the files, and reads them.
#'
#' Select a dataset from the IHME GBD results and download it.
#' You will receive an email with a url.
#' Use the url to download the data.
#' @export
#'
#' @examples
#' \dontrun{
#' # This is a dontrun example because it requires a valid url.
#' url <- "https://www.healthdata.org/.../some-file.zip"
#' getunz(url)
#' }
#'
getunz <- function(url) {
  url <- url
  temp_dir <- tempdir()
  zip_file <- file.path(temp_dir, "data.zip")
  utils::download.file(url, destfile = zip_file, mode = "wb")
  utils::unzip(zip_file, exdir = temp_dir)
  csv_file <- list.files(temp_dir,
    pattern = "\\.csv$",
    full.names = TRUE)
  data <- purrr::map(csv_file, utils::read.csv)
  data
}