R/sn_set_cache_folder.R

In giocomai/streetnamer: Match street names to their Wikidata identifier with a Shiny interface

#' Set folder for caching data
#'
#' Consider using a folder out of your current project directory, e.g. `sn_set_cache_folder("~/R/sn_data/")`: you will be able to use the same cache in different projects, and prevent cached files from being sync-ed if you use services such as Nextcloud or Dropbox.
#'
#' @param path A path to a location used for caching data. If the folder does not exist, it will be created.
#'
#' @return The path to the caching folder, if previously set; the same path as given to the function; or the default, `sn_data` is none is given.
#' @export

#' @examples
#' \dontrun{
#' sn_set_cache_folder("~/R/sn_data/")
#' }
sn_set_cache_folder <- function(path = NULL) {
  if (is.null(path)) {
    path <- Sys.getenv("sn_cache_folder")
  } else {
    Sys.setenv(sn_cache_folder = path)
  }
  if (path == "") {
    path <- fs::path("sn_data")
  }
  path
}

#' @rdname sn_set_cache_folder
#' @examples
#' sn_get_cache_folder()
#' @export
sn_get_cache_folder <- sn_set_cache_folder