R/dimsum__create_dir.R

Defines functions dimsum__create_dir

Documented in dimsum__create_dir

#' dimsum__create_dir
#'
#' Create results folder for dimsum pipeline stage.
#'
#' @param dimsum_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
dimsum__create_dir <- function(
  dimsum_dir, 
  execute, 
  message = NULL, 
  overwrite_dir = TRUE){
  if(!execute){
    if(!is.null(message)){
      dimsum__status_message(paste("\n\n\n*******", message, "(not executed)", "*******\n\n\n"))
    }
    return()
  }
  if(!is.null(message)){
    dimsum__status_message(paste("\n\n\n*******", message, "*******\n\n\n"))
  }
  if(dir.exists(dimsum_dir) & overwrite_dir){
    unlink(dimsum_dir, recursive = TRUE)
  }
  dir.create(dimsum_dir, showWarnings = FALSE)
}
lehner-lab/DiMSum documentation built on April 10, 2024, 4:15 a.m.