R/utils_save-load.R

In jdtrat/jdtools: Helpful Tools and Code for Programming in R

jt <- new.env(parent = emptyenv())

unknown_error_msg <- function() {
  cli::cli_abort("Unknown error. Please try supplying a different object, or filing an issue at {.url https://github.com/jdtrat/jdtools/issues}.")
}



set_object_path_internal <- function(.path) {
  options(jdtools.rds.path = .path)

  if (getOption("jdtools.rds.path") == .path) {
    cli::cli_alert_success("Calling {.code jdtools::save_object()} will save objects to {.file {here::here(.path)}}.")
  }
}

#' Set global path option for saving/loading objects
#'
#' This function will set the global option for saving/loading objects with
#' `jdtools` functions so you do not have to specify the `path` parameter when
#' calling \code{\link{save_object}} and \code{\link{load_object}}.
#'
#' @param path A directory within the current RStudio Project
#'
#' @return NA; used for side effects to set the global option
#'   `jdtools.rds.path`.
#'
#' @family utils-save-load
#'
#' @export
#'
#' @examples
#'
#' if (interactive()) {
#'
#' fs::dir_create(here::here("test-folder"))
#' jdtools::set_object_path("test-folder")
#'
#' }
#'
set_object_path <- function(path) {

  path <- here::here(path)

  if (fs::dir_exists(path)) {
    set_object_path_internal(path)
  } else if (!fs::dir_exists(path)) {
    cl_yes_no_action(prompt = "The directory {.file {path}} does not exist. Would you like to create it?",
           yes_action = {
             fs::dir_create(path)
             cli::cli_alert_success("Created directory at {.file {path}}")
             set_object_path_internal(path)
             print("blah")
             },
           no_message ="The directory {.file {path}} was not created.
           Try calling {.code jdtools::save_object()} with an existing directory or create one when prompted.")
  }

}

#' Get global path option for saving/loading objects
#'
#' @return NA; used for side effects to get the global option
#'   `jdtools.rds.path` if applicable.
#'
#' @family utils-save-load
#'
#' @export
#'
#' @examples
#'
#' if (interactive()) {
#'
#' fs::dir_create(here::here("test-folder"))
#' # Will state option is unset
#' jdtools::get_object_path()
#'
#' jdtools::set_object_path("test-folder")
#' # Will return path
#' jdtools::get_object_path()
#'
#' }
#'
get_object_path <- function() {

  path <- getOption("jdtools.rds.path")

  if (is.null(path)) {
    cli::cli_alert_danger("Option {.envvar jdtools.rds.path} is not set. \n To set the directory for saving objects, call {.code jdtools::set_object_path()}")
  } else {
    here::here(path)
  }

}

#' Unset global path option for saving/loading objects
#'
#' @return NA; used for side effects to unset the global option
#'   `jdtools.rds.path`.
#'
#' @family utils-save-load
#'
#' @export
#'
#' @examples
#'
#' if (interactive()) {
#'
#' fs::dir_create(here::here("test-folder"))
#' # Will get message saying no path is set.
#' jdtools::unset_object_path("test-folder")
#' jdtools::set_object_path("test-folder")
#' # Will actually unset the path.
#' jdtools::unset_object_path("test-folder")
#'
#' }
#'
unset_object_path <- function() {

  path <- getOption("jdtools.rds.path")

  if (is.null(path)) {
    cli::cli_alert_danger("Option {.envvar jdtools.rds.path} is not defined, so it cannot be unset.")
  } else if (!is.null(path)) {
    options("jdtools.rds.path" = NULL)
    cli::cli_alert_success("Option {.envvar jdtools.rds.path} has been unset.")
  }

}