| Title: | Simple Progress Bars for Procedural Coding |
|---|---|
| Description: | Provides a simple progress bar to use for basic and advanced users that suits all those who prefer procedural programming. It is especially useful for integration into markdown files thanks to the progress bar's customisable appearance. |
| Authors: | Fabio Ashtar Telarico [aut, cre]
|
| Maintainer: | Fabio Ashtar Telarico <[email protected]> |
| License: | GPL (>= 3) |
| Version: | 1.0 |
| Built: | 2024-11-20 06:23:33 UTC |
| Source: | CRAN |
Function to create a simple progress bar
create_pb( length, remaining = "-", done = "=", percentage = TRUE, message = TRUE, custom.message = NULL, trim = 6L, print = TRUE, colour = "red", bg.colour = "white" )create_pb( length, remaining = "-", done = "=", percentage = TRUE, message = TRUE, custom.message = NULL, trim = 6L, print = TRUE, colour = "red", bg.colour = "white" )
length |
Length of the progress bar. For instance, in a loop it would be the number of iterations to complete. |
remaining |
The character (string of unitary length) used to represent operations still to do. |
done |
The character (string of unitary length) used to represent operations already completed |
percentage |
Logical | Whether to print the percentage progess after the bar. Defaults to |
message |
Logical | Whether to print a message before the progress bar. Defaults to |
custom.message |
Optional message to be printed before the progress bar. Defaults to |
trim |
How many points to trim from the maximum length of the terminal output. Default to |
print |
Logical | Whether to print the progress bar after its initialisation. Defaults to |
colour |
Styling of the progress bar object. It can be a single string, in which case it applies to all the part of the progress bar (message, bar and percentage). It can also be a vector of length 3, in which case each string applies to one of the items (respectively message, bar and percentage). The strings must be taken amongst the following values:
|
bg.colour |
Styling of the progress bar object's background. It can be a single string, in which case it applies to all the part of the progress bar (message, bar and percentage). It can also be a vector of length 3, in which case each string applies to one of the items (respectively message, bar and percentage). The strings must be taken amongst the following values:
|
An object of the S4 class simple.progess.bar containing:
message |
A string representing the message to be printed together with the bar |
bar |
The progress bar |
percentage |
Progress in percentage |
length |
Length of the progress bar (integer) |
remaining |
Character representing the remaining operations |
done |
Character representing the operations already completed |
style_msg |
Styling of |
style_bar |
Styling of |
style_perc |
Styling of |
Telarico, Fabio Ashtar
# Example without custom colours or custom message pb<-create_pb(length=10, print=TRUE) # Example without custom colours but with custom message pb<-create_pb(length=10, custom.message = 'Custom progress message:', print = TRUE) # Example with custom colours and custom message pb<-create_pb(length=10, custom.message = 'Custom progress message:', print = TRUE,colour = c('magenta','red','blue'))# Example without custom colours or custom message pb<-create_pb(length=10, print=TRUE) # Example without custom colours but with custom message pb<-create_pb(length=10, custom.message = 'Custom progress message:', print = TRUE) # Example with custom colours and custom message pb<-create_pb(length=10, custom.message = 'Custom progress message:', print = TRUE,colour = c('magenta','red','blue'))
Print method for simple progress bars
## S4 method for signature 'simple.progress.bar' print(x)## S4 method for signature 'simple.progress.bar' print(x)
x |
A simple progress bar |
Nothing. Prints the progress bar to the console
Telarico, Fabio Ashtar
# Example without custom colours or custom message pb<-create_pb(length=10, print=FALSE) print(pb)# Example without custom colours or custom message pb<-create_pb(length=10, print=FALSE) print(pb)
Class of a simple progress bar
Telarico, Fabio Ashtar
pb<-create_pb(length=10, print=FALSE) class(pb)pb<-create_pb(length=10, print=FALSE) class(pb)
Summary method for simple progress bars
## S4 method for signature 'simple.progress.bar' summary(object)## S4 method for signature 'simple.progress.bar' summary(object)
object |
A simple progress bar |
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.
Telarico, Fabio Ashtar
# 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)# 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)
Function to update the progress of a simple progress bar
update_pb(pb, value)update_pb(pb, value)
pb |
Name of the progress bar to update, previously initialised with |
value |
Level of progress of the bar |
Prints the progress bar with the new value and returns an object of the S4 class simple.progess.bar containing:
message |
A string representing the message to be printed together with the bar |
bar |
The progress bar |
percentage |
Progress in percentage |
length |
Length of the progress bar (integer) |
remaining |
Character representing the remaining operations |
done |
Character representing the operations already completed |
style_msg |
Styling of |
style_bar |
Styling of |
style_perc |
Styling of |
Telarico, Fabio Ashtar
# A single bar in a loop pb<-create_pb(length=10, print=TRUE) for(i in 1:10){ cat('This is the number',i,'\n') pb<-update_pb(pb,i) Sys.sleep(.3) cat(pb$value,'operation completed\n') } # Two progress bars in multiple loops pb_for<-create_pb(length=3, print=TRUE,colour='red') for(i in 1:3){ cat('This is the number',i,'\n') pb_for<-update_pb(pb_for,i) Sys.sleep(1) pb_while<-create_pb(length=i, print=TRUE,colour='blue') while(pb_while$value<i){ cat('This is a subtask \n') pb_while<-update_pb(pb_while,pb_while$value+1) Sys.sleep(1) } }# A single bar in a loop pb<-create_pb(length=10, print=TRUE) for(i in 1:10){ cat('This is the number',i,'\n') pb<-update_pb(pb,i) Sys.sleep(.3) cat(pb$value,'operation completed\n') } # Two progress bars in multiple loops pb_for<-create_pb(length=3, print=TRUE,colour='red') for(i in 1:3){ cat('This is the number',i,'\n') pb_for<-update_pb(pb_for,i) Sys.sleep(1) pb_while<-create_pb(length=i, print=TRUE,colour='blue') while(pb_while$value<i){ cat('This is a subtask \n') pb_while<-update_pb(pb_while,pb_while$value+1) Sys.sleep(1) } }