R/clc.R

In mrdwab/SOfun: Functions From Answers to R Questions on Stack Overflow

#' Clear your workspace
#' 
#' A slightly more elaborate version of `rm(list = ls())` to clear your workspace.
#' 
#' @param all Logical. Should hidden objects also be removed? Defaults to `FALSE`.
#' @return Nothing
#' @author Ananda Mahto
#' @references <http://stackoverflow.com/a/20389913/1270695>
#' @examples
#' 
#' \dontrun{
#' clc()      # Will not affect hidden files
#' clc(TRUE)  # Will affect hidden files
#' }
#' 
#' @export clc
clc <- function(all = FALSE) {
  rm(list = ls(.GlobalEnv, all.names = all), envir = .GlobalEnv)
}