R/cache_download.R

In QuartzSoftwareLLC/tidyiddr: Provides downloads of the IDDR Data

#' Cache Download
#'
#'  By default, all downloads are cached both on the disk and in your computer memory.
#' This means that the second time you download a file during the same session it will be reloaded from your ram.
#' If you stop a session and restart it, the file will be loaded from your disk.
#' If you want to reload the data from its original source, use the bust_cache function.
#' 
#' Additionally, options can be used to determine the default caching behavior of tidyiddr.
#' @export
#' @examples
#' cache_download("https://s3.amazonaws.com/quartzdata/datasets/caserates-by-age.csv")
#'
#' options("tidyiddr_use_cache" = TRUE)
#' cache_download("https://s3.amazonaws.com/quartzdata/datasets/caserates-by-age.csv")
#' @param url The URL to download from.
#' @param use_memory Whether to use memory caching.
#' @param use_disk Whether to use disk caching.
#' @param bust_cache Whether to bust (refresh) the cache.
#' @param ... arguments to forward to the vroom::vroom function.
cache_download <- function(url, ..., use_memory = TRUE, use_disk = TRUE, bust_cache = FALSE) {
  print("caching has been depreceated. Please use memoise for cahching instead")
}