R/save_result.r

In EvoLandEco/eve: Evolution Emulator, phylogenetically dependent

#' save_result
#' @param out Result object to be saved to file
#' @param name Name of the simulation job, this will create a folder in the same
#' name
#' @param set The index of the parameter set in the whole parameter sets
#' @author Tianjian Qin
save_result <- function(out,
                        name,
                        set = NULL) {
  if (is.null(set)) {
    file_name <- paste0(name, ".RData")
  } else {
    file_name <- paste0(name, "_", set, ".RData")
  }

  out_folder <- file.path(getwd(),
                          name)

  file_path <- file.path(out_folder, file_name)

  message(paste0("\nSaving result to ",
                 file_path,
                 "\n"))

  save(out, file = file_path)

  if (file.exists(file_path)) {
    message(paste0("Result saved", "\n"))
  } else {
    warning(paste0("Failed to save result to ",
                   file_path))
  }
}



#' check_folder
#' @param name A string, name of the simulation job
#' @param verbose Logical, decides whether to print information
#' @author Tianjian Qin
check_folder <- function(name, verbose = TRUE) {
  out_folder <- file.path(getwd(),
                          name)
  if (!dir.exists(out_folder)) {
    if (verbose == TRUE) {
      message(paste0("Attempting to create folder ",
                     out_folder,
                     "\n"))
    }
    dir.create(out_folder, recursive = TRUE)
  } else {
    if (verbose == TRUE) {
      message(out_folder, " already exists\n")
    }
  }

  if (!dir.exists(out_folder)) {
    stop(paste0("Failed to create folder", out_folder, "\n"))
  } else {
    if (verbose == TRUE) {
      message("Folder exists\n")
    }
  }
}



#' check_path
#' @param path Specify the path to be checked
#' @param verbose Logical, decides whether to print information
#' @author Tianjian Qin
check_path <- function(path, verbose = TRUE) {
  if (!dir.exists(path)) {
    if (verbose == TRUE) {
      message(paste0("Attempting to create path ",
                     path,
                     "\n"))
    }
    dir.create(path, recursive = TRUE)
  } else {
    if (verbose == TRUE) {
      message(path, " already exists\n")
    }
  }

  if (!dir.exists(path)) {
    stop(paste0("Failed to create path", path, "\n"))
  } else {
    if (verbose == TRUE) {
      message("Path exists\n")
    }
  }
}