R/ProgressBar.R

In raubreywhite/RAWmisc: R Convenience functions

#' Creates a progress bar
#' @param min Minimum
#' @param max Maximum
#' @param flush Should it flush or print the output?
#' @export ProgressBarCreate
ProgressBarCreate <- function(min = 0, max = 1, flush = TRUE) {
  pb <- list()
  pb$min <- min
  pb$max <- max
  pb$timeStart <- Sys.time()
  pb$flush <- flush
  class(pb) <- "RAWmiscProgressBar"
  return(pb)
}

#' Sets progress bar's progress
#' @param pb A progress bar
#' @param value The value
#' @importFrom utils flush.console
#' @export ProgressBarSet
ProgressBarSet <- function(pb, value) {
  if (!inherits(pb, "RAWmiscProgressBar")) stop("'pb' is not from class 'RAWmiscProgressBar")

  timeTaken <- as.numeric(difftime(Sys.time(), pb$timeStart, units = "mins"))
  propCompleted <- (value - pb$min) / (pb$max - pb$min)
  if (propCompleted == 0) {
    timeTotal <- 1000
  } else {
    timeTotal <- timeTaken / propCompleted
  }
  timeLeft <- timeTotal - timeTaken

  hoursLeft <- floor(timeLeft / 60)
  minsLeft <- floor(timeLeft %% 60)
  timeEnd <- data.table::as.ITime(Sys.time()) + as.ITime(sprintf("%s:%s", hoursLeft, minsLeft))

  retval <- sprintf(
    "\r%s|%s|%s Total time: %s min. %s%% completed in %s min. %s min remaining.",
    format(pb$timeStart, "%H:%M:%S"),
    format(Sys.time(), "%H:%M:%S"),
    format(timeEnd, "%H:%M:%S"),
    Format(timeTotal, digits = 1),
    Format(propCompleted * 100, digits = 0),
    Format(timeTaken, digits = 1),
    Format(timeLeft, digits = 1)
  )
  if (pb$flush | value == pb$max) {
    cat(retval)
    utils::flush.console()
  } else {
    cat(retval, "\r\n")
  }
}