new function get_cache_dir()

NAMESPACE

@@ -3,6 +3,7 @@
 export(download_cnefe)
 export(geocode)
 export(geocodebr_cache)
+export(get_cache_dir)
 export(set_cache_dir)
 importFrom(data.table,"%chin%")
 importFrom(data.table,"%like%")

R/set_cache_dir.R

@@ -5,7 +5,7 @@
 #'
 #' @param path A string. The path to the directory used to cache the data. If
 #'   `NULL` (the default), the package will use a versioned directory saved
-#'   inside the directory returned by [tools::R_user_dir].
+#'   inside the directory returned by [tools::R_user_dir()].
 #'
 #' @return Invisibly returns the cache directory path.
 #'
@@ -39,3 +39,26 @@ set_cache_dir <- function(path = NULL) {
 
   return(invisible(cache_dir))
 }
+
+#' Get the cache directory used in geocodebr
+#'
+#' Gets the directory used to cache CNEFE data. Useful to inspect the directory
+#' set with [set_cache_dir()] in a previous R session. Returns the default cache
+#' directory if no custom directory has been previously set.
+#'
+#' @return The cache directory path.
+#'
+#' @examples
+#' get_cache_dir()
+#'
+#' @export
+get_cache_dir <- function() {
+  if (fs::file_exists(cache_config_file)) {
+    cache_dir <- readLines(cache_config_file)
+    cache_dir <- fs::path_norm(cache_dir)
+  } else {
+    cache_dir <- default_cache_dir
+  }
+
+  return(cache_dir)
+}