R/seeoutput.R

In crazybilly/muadc: A collection of functions and variables

#' See Output Directory
#'
#' @description Opens a Windows directory to the path given to the dir argument, by default, the output/ directory. If the given directory does not exist, a warning is thrown and the current working directory is opened.
#' 
#' @param dir the path to a directory to open
#'
#' @return returns a NULL value when successfull, primarily useful for its side effect.
#' @export
#'
seeoutput  <- function( dir = 'output') {
  
  origdir  <- dir
  
  if(!dir.exists(dir) ) {
    origdir  <-  getwd()
    warning(paste(origdir, "does not exist, opening working directory."))
  }
  
  
  shell.exec(dir)
  
}

#' @inherit seeoutput
#' @export
seedata  <- function(d = 'data') { seeoutput(dir = d) }