R/utils-progress.R

In beauchamplab/rave: R Analysis and Visualization of 'ECOG/iEEG' Data

#' A wrapper for shiny Progress object
#' @details shiny::Progress class cannot be used under non-reactive environment.
#' rave::progress function wrap it up so that you can use it in non-reactive settings.
#' @param title Main title for progress bar
#' @param max How many steps you have for this process
#' @param session shiny session, default is \code{\link[shiny]{getDefaultReactiveDomain}}
#' @param quiet nonreactive-only mode? default is FALSE. If TRUE, then progress bar will be hidden in shiny app
#' @param ... other parameters passing to \code{\link[dipsaus]{progress2}}
#' @export
progress <- function(
  title, max = 1,
  session = getDefaultReactiveDomain(),
  quiet = FALSE, ...
){
  # Re-write in dipsaus
  return(dipsaus::progress2(title = title, max = max, session = session, quiet = quiet, ...))
}