- Notifications
You must be signed in to change notification settings - Fork41
Progress bar in your R terminal
License
Unknown, MIT licenses found
Licenses found
r-lib/progress
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Progress bar in your R terminal
An R package to show ASCII progress bars. Heavily influenced bythehttps://github.com/tj/node-progress JavaScript project.
Install the package from CRAN:
install.packages("progress")If you need the development version, install it from GitHub:
pak::pak("r-lib/progress")
Use theprogress_bar R6 class:
library(progress)pb<-progress_bar$new(total=100)for (iin1:100) {pb$tick() Sys.sleep(1/100)}
[==========================================================-------------] 81%The progress bar is displayed after the firsttick command.This might not be desirable for long computations, becausenothing is shown before the first tick. It is good practice tocalltick(0) at the beginning of the computation or download,which shows the progress bar immediately.
pb<-progress_bar$new(total=100)f<-function() {pb$tick(0) Sys.sleep(3)for (iin1:100) {pb$tick() Sys.sleep(1/100) }}f()
Custom format, with estimated time of completion:
pb<-progress_bar$new(format=" downloading [:bar] :percent eta: :eta",total=100,clear=FALSE,width=60)for (iin1:100) {pb$tick() Sys.sleep(1/100)}
downloading [========----------------------] 28% eta: 1sWith elapsed time:
pb<-progress_bar$new(format=" downloading [:bar] :percent in :elapsed",total=100,clear=FALSE,width=60)for (iin1:100) {pb$tick() Sys.sleep(1/100)}
downloading [==========================------] 80% in 1spb<-progress_bar$new(format=" downloading [:bar] :elapsedfull",total=1000,clear=FALSE,width=60)for (iin1:1000) {pb$tick() Sys.sleep(1/100)}
downloading [=====================--------------] 00:00:08With number of number of ticks/total:
total<-1000pb<-progress_bar$new(format="[:bar] :current/:total (:percent)",total=total)f<-function() {pb$tick(0) Sys.sleep(3)for (iin1:total) {pb$tick(1) Sys.sleep(1/100) }}f()
[============================-------------------------------------------------] 370/1000 ( 37%)With custom tokens:
pb<-progress_bar$new(format=" downloading :what [:bar] :percent eta: :eta",clear=FALSE,total=200,width=60)f<-function() {for (iin1:100) {pb$tick(tokens=list(what="foo")) Sys.sleep(2/100) }for (iin1:100) {pb$tick(tokens=list(what="foobar")) Sys.sleep(2/100) }}f()
downloading foo [======------------------] 27% eta: 4sIt can show download rates for files with unknown sizes:
pb<-progress_bar$new(format=" downloading foobar at :rate, got :bytes in :elapsed",clear=FALSE,total=1e7,width=60)f<-function() {for (iin1:100) {pb$tick(sample(1:100*1000,1)) Sys.sleep(2/100) }pb$tick(1e7)invisible()}f()
downloading foobar at 5.42 MB/s, got 15.45 MB in 3sProgress bars can also digress, by supplying negative values totick():
pb<-progress_bar$new()f<-function() {pb$tick(50) ; Sys.sleep(1)pb$tick(-20) ; Sys.sleep(1)pb$tick(50) ; Sys.sleep(1)pb$tick(-30) ; Sys.sleep(1)pb$tick(100)}f()
See the manual for details and other options.
If you prefer to do your iterative tasks using thepurrr family of functional programming tools, rather than withfor loops, there are two straightforward ways to add progress bars:
Increment the ticksin-line when calling the
purrriterator.Define the task and increment the ticks in a separate wrapper function.
Option 1 is concise for simple one-line tasks (e.g. requiring only a single function call), whileOption 2 is probably preferred for more complex multi-line tasks.
# Option 1pb<-progress_bar$new(total=100)purrr::walk(1:100, \(...) {pb$tick(); Sys.sleep(0.1) })
[================================================>------] 89%# Option 2pb<-progress_bar$new(total=100)foo<-function(x){pb$tick() Sys.sleep(0.1)}purrr::walk(1:100,foo)
[==================>------------------------------------] 34%It is easy to create progress bars forplyr:
progress_progress<-function(...) {pb<-NULLlist(init=function(x,...) {pb<<-progress_bar$new(total=x,...) },step=function() {pb$tick() },term=function()NULL )}
You can try it with
plyr::l_ply(1:100,.fun=function(...) Sys.sleep(0.01),.progress='progress')
The package also provides a C++ API, that can be used with orwithout Rcpp. Seethe example package thatisincluded withinprogress. Here is a short excerptthat shows how it works:
#include<RProgress.h>...RProgress::RProgresspb("Downloading [:bar] ETA: :eta"); pb.tick(0);for (int i =0; i <100; i++) {usleep(2.0 /100 *1000000); pb.tick(); }...
The C++ API has almost the same functionality as the R API, except that itdoes not currently support custom tokens, custom streams, and callback functions.
Note that the C++ and the R APIs are independent and for asingle progress bar you need to use either one exclusively.
MIT @Gábor Csárdi,RStudio Inc
About
Progress bar in your R terminal
Topics
Resources
License
Unknown, MIT licenses found
Licenses found
Code of conduct
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Uh oh!
There was an error while loading.Please reload this page.
Contributors14
Uh oh!
There was an error while loading.Please reload this page.