summary,simple.progress.bar-method {SPB}

Summary method for simple progress bars

Description

Summary method for simple progress bars

Usage

## S4 method for signature 'simple.progress.bar'
summary(object)

Arguments

object

A simple progress bar

Value

A summary including:

message

The message printed before the bar (if any)

status

The advancement status of the bar

max

The length of the bar

percentage

The advancement status of the bar in percentage points

The summary is also printed to the console as a kable (if knitr is installed). Otherwise it prints out as a normal table.

Author(s)

Telarico, Fabio Ashtar

Examples

# Example without custom message
pb<-create_pb(length=10, print=FALSE)
summary(pb)

# Example with a custom message
pb<-create_pb(length=43, print=FALSE,custom.message='Custom pb')
summary(pb)

# Example with a custom message and an updated value
pb<-create_pb(length=11, print=FALSE,custom.message='A new value:')
pb<-update_pb(pb,6)
summary(pb)