R/dimsumms__create_dir.R

In lehner-lab/dimsumms: Analysis scripts to reproduce the figures and results from DiMSum manuscript

#' dimsumms__create_dir
#'
#' Create results folder for analysis script plots and saved objects.
#'
#' @param dimsumms_dir directory path string (required)
#' @param execute whether or not the system command will be executed (required)
#' @param message message string (optional, default: NULL i.e. no message displayed)
#' @param overwrite_dir delete directory if already exists (optional, default: TRUE)
#'
#' @return Nothing
#' @export
dimsumms__create_dir <- function(
  dimsumms_dir, 
  execute = TRUE, 
  message = NULL, 
  overwrite_dir = TRUE){
  if(!execute){
    return()
  }
  if(!is.null(message)){
    message(paste("\n\n\n*******", message, "*******\n\n\n"))
  }
  if(dir.exists(dimsumms_dir) & overwrite_dir){
    unlink(dimsumms_dir, recursive = TRUE)
  }
  dir.create(dimsumms_dir, showWarnings = FALSE)
  return(dimsumms_dir)
}