R/sessionExit.R

In lgnbhl/polyglot: Learn Foreign Language Vocabulary

#' Exit the interactive environment
#'
#' This function will quit the interactive learning environment.
#'
#' @details
#' This function calculates the learning session time and print it. Then, it
#' cleans the Global Environment if needed and displays a farewell message.
#'
#' @param assign.env An environment
#'

sessionExit <- function(assign.env = parent.frame(1)) {
  sessionEndTime <- Sys.time()
  sessionTimer <- as.numeric(sessionEndTime - sessionStartTime, units = "mins")
  if(round(sessionTimer) <= 1) {
    cat(paste("| Learning session time:", round(sessionTimer),"minute. \n"))
  } else {
    cat(paste("| Learning session time:", round(sessionTimer),"minutes. \n"))
    }
  cat("| Learning dataset saved. Cleaning environment... \n")
  if(exists("sessionDataset")) {
    rm(sessionDataset, envir = globalenv())
  }
  if(exists("datasetAbsolutePath")) {
    rm(datasetAbsolutePath, envir = globalenv())
  }
  if(exists("sessionStartTime")) {
    rm(sessionStartTime, envir = globalenv())
  }
  cat("| Leaving polyglot now. Type learn() to resume. \n")
  invisible()
}