R/Progress.R

In pkrog/biodb: biodb, a library and a development framework for connecting to chemical and biological databases

#' Progress class.
#'
#' @description
#' A class for informing user about the progress of a process.
#'
#' @details
#' This class displays progress of a process to user, and sends
#' notifications of this progress to observers too.
#'
#' @examples
#' # Create an instance
#' prg <- biodb::Progress$new(msg='Processing data.', total=10L)
#'
#' # Processing
#' for (i in seq_len(10)) {
#'     print("Doing something.")
#'     prg$increment()
#' }
#'
#' @import R6
#' @import chk
#' @import progress
#' @export
Progress <- R6::R6Class('Progress'

,public=list(

#' @description
#' Initializer.
#' @param biodb A BiodbMain instance that will be used to notify observers of
#' progress.
#' @param msg The message to display to the user.
#' @param total The total number of elements to process or NA if unknown.
#' @return Nothing.
initialize=function(biodb=NULL, msg, total=NA_integer_){
    if ( ! is.null(biodb))
        chk::chk_is(biodb, "BiodbMain")
    chk::chk_string(msg)
    chk::chk_integer(total)
    if ( ! is.na(total)) {
        chk::chk_whole_number(total)
        chk::chk_gte(total, 0)
    }

    private$biodb <- biodb
    private$msg <- msg
    private$index <- 0
    private$total <- total
    fmt <- if (is.na(total)) ":spin :elapsedfull" else
        "[:bar] :percent ETA: :eta"
    fmt <- sprintf("%s %s", msg, fmt) # Add message
    private$bar <- progress::progress_bar$new(format=fmt, total=total)

    return(invisible(NULL))
}

#' @description
#' Increment progress.
#' @return Nothing.
,increment=function() {
    
    private$index <- private$index + 1

    # Update progress bar
    private$bar$tick()
    
    # Notify biodb observers
    if ( ! is.null(private$biodb))
        notifyObservers(private$biodb$getObservers(), 'notifyProgress',
            what=private$msg, index=private$index, total=private$total)
    
    return(invisible(NULL))
}    
)

,private=list(
    biodb=NULL,
    msg=NULL,
    total=NULL,
    index=NULL,
    bar=NULL
))