• Stars
    star
    447
  • Rank 89,451 (Top 2 %)
  • Language
    R
  • License
    Other
  • Created about 9 years ago
  • Updated about 1 month ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Progress bar in your R terminal



progress


R-CMD-check Codecov test coverage

Progress bar in your R terminal

An R package to show ASCII progress bars. Heavily influenced by the https://github.com/tj/node-progress JavaScript project.

Installation

Install the package from CRAN:

install.packages("progress")

If you need the development version, install it from GitHub:

pak::pak("r-lib/progress")

Usage

Use the progress_bar R6 class:

library(progress)
pb <- progress_bar$new(total = 100)
for (i in 1:100) {
  pb$tick()
  Sys.sleep(1 / 100)
}
[==========================================================-------------]  81%

The progress bar is displayed after the first tick command. This might not be desirable for long computations, because nothing is shown before the first tick. It is good practice to call tick(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 (i in 1: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 (i in 1:100) {
  pb$tick()
  Sys.sleep(1 / 100)
}
  downloading [========----------------------]  28% eta:  1s

With elapsed time:

pb <- progress_bar$new(
  format = "  downloading [:bar] :percent in :elapsed",
  total = 100, clear = FALSE, width= 60)
for (i in 1:100) {
  pb$tick()
  Sys.sleep(1 / 100)
}
  downloading [==========================------]  80% in  1s
pb <- progress_bar$new(
  format = "  downloading [:bar] :elapsedfull",
  total = 1000, clear = FALSE, width= 60)
for (i in 1:1000) {
  pb$tick()
  Sys.sleep(1 / 100)
}
  downloading [=====================--------------] 00:00:08

With number of number of ticks/total:

total <- 1000
pb <- progress_bar$new(format = "[:bar] :current/:total (:percent)", total = total)
f <- function() {
  pb$tick(0)
  Sys.sleep(3)
  for (i in 1: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 (i in 1:100) {
    pb$tick(tokens = list(what = "foo   "))
    Sys.sleep(2 / 100)
  }
  for (i in 1:100) {
    pb$tick(tokens = list(what = "foobar"))
    Sys.sleep(2 / 100)
  }
}
f()
  downloading foo    [======------------------]  27% eta:  4s

It 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 (i in 1: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  3s

Progress bars can also digress, by supplying negative values to tick():

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.

Usage with purrr iterators

If you prefer to do your iterative tasks using the purrr family of functional programming tools, rather than with for loops, there are two straightforward ways to add progress bars:

  1. Increment the ticks in-line when calling the purrr iterator.

  2. 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), while Option 2 is probably preferred for more complex multi-line tasks.

# Option 1
pb <- progress_bar$new(total = 100)
purrr::walk(1:100, ~{pb$tick(); Sys.sleep(0.1)})
[================================================>------]  89%
# Option 2
pb <- progress_bar$new(total = 100)

foo <- function(x){
  pb$tick()
  Sys.sleep(0.1)
}

purrr::walk(1:100, foo)
[==================>------------------------------------]  34%

Creating a plyr compatible progress bar

It is easy to create progress bars for plyr:

progress_progress <- function(...) {
  pb <- NULL
  list(
    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'
)

C++ API

The package also provides a C++ API, that can be used with or without Rcpp. See the example package that is included within progress. Here is a short excerpt that shows how it works:

#include <RProgress.h>

...

RProgress::RProgress pb("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 it does not currently support custom tokens, custom streams, and callback functions.

Note that the C++ and the R APIs are independent and for a single progress bar you need to use either one exclusively.

License

MIT @ Gรกbor Csรกrdi, RStudio Inc

More Repositories

1

devtools

Tools to make an R developer's life easier
R
2,331
star
2

lintr

Static Code Analysis for R
R
1,122
star
3

httr

httr: a friendly http package for R
R
975
star
4

actions

GitHub Actions for the R community
JavaScript
868
star
5

testthat

An R ๐Ÿ“ฆ to make testing ๐Ÿ˜€
R
849
star
6

usethis

Set up commonly used ๐Ÿ“ฆ components
R
798
star
7

pkgdown

Generate static html documentation for an R package
R
686
star
8

styler

Non-invasive pretty printing of R code
R
657
star
9

pak

A fresh approach to package installation
C
575
star
10

cli

Tools for making beautiful & useful command line interfaces
R
571
star
11

roxygen2

Generate R package documentation from inline R comments
R
553
star
12

rig

The R Installation Manager
Rust
460
star
13

rlang

Low-level API for programming with R
R
454
star
14

R6

Encapsulated object-oriented programming for R
R
393
star
15

here

A simpler way to find your files
R
387
star
16

scales

Tools for ggplot2 scales
R
370
star
17

fs

Provide cross platform file operations based on libuv.
C
353
star
18

covr

Test coverage reports for R
R
328
star
19

rex

Friendly regular expressions for R.
R
325
star
20

crayon

๐Ÿ–๏ธ R package for colored terminal output โ€” now superseded by cli
R
321
star
21

memoise

Easy memoisation for R
R
310
star
22

remotes

Install R packages from GitHub, GitLab, Bitbucket, git, svn repositories, URLs
R
309
star
23

lobstr

Understanding complex R objects with tools similar to str()
R
294
star
24

callr

Call R from R
R
281
star
25

waldo

Find differences between R objects
R
272
star
26

vctrs

Generic programming with typed R vectors
C
272
star
27

slider

Sliding Window Functions
R
267
star
28

zeallot

Variable assignment with zeal! (or multiple, unpacking, and destructuring assignment in R)
R
245
star
29

conflicted

An alternative conflict resolution strategy for R
R
242
star
30

bench

High Precision Timing of R Expressions
R
237
star
31

gmailr

Access the Gmail RESTful API from R.
R
234
star
32

processx

Execute and Control Subprocesses from R
R
225
star
33

xml2

Bindings to libxml2
R
213
star
34

asciicast

Turn R scripts into terminal screencasts
R
211
star
35

gh

Minimalistic GitHub API client in R
R
210
star
36

httr2

Make HTTP requests and process their responses. A modern reimagining of httr.
R
203
star
37

cpp11

cpp11 helps you to interact with R objects using C++ code.
C++
185
star
38

keyring

๐Ÿ” Access the system credential store from R
R
185
star
39

vdiffr

Visual regression testing and graphical diffing with testthat
C++
177
star
40

svglite

A lightweight svg graphics device for R
C++
177
star
41

pillar

Format columns with colour
R
173
star
42

ragg

Graphic Devices Based on AGG
C++
169
star
43

ymlthis

write YAML for R Markdown, bookdown, blogdown, and more
R
163
star
44

hugodown

Make websites with hugo and RMarkdown
R
163
star
45

withr

Methods For Temporarily Modifying Global State
R
158
star
46

rprojroot

Finding files in project subdirectories
R
146
star
47

coro

Coroutines for R
R
146
star
48

debugme

Easy and efficient debugging for R packages
R
144
star
49

available

Check if a package name is available to use
R
141
star
50

ellipsis

Tools for Working with ...
R
138
star
51

archive

R bindings to libarchive, supporting a large variety of archive formats
C++
138
star
52

gert

Simple git client for R
C
135
star
53

itdepends

R
133
star
54

later

Schedule an R function or formula to run after a specified period of time.
C++
132
star
55

rray

Simple Arrays
R
130
star
56

isoband

isoband: An R package to generate contour lines and polygons.
C++
128
star
57

prettyunits

Pretty, human readable formatting of quantities
JavaScript
126
star
58

fastmap

Fast map implementation for R
C++
124
star
59

tidyselect

A backend for functions taking tidyverse selections
R
122
star
60

desc

Manipulate DESCRIPTION files
R
120
star
61

gargle

Infrastructure for calling Google APIs from R, including auth
R
112
star
62

rcmdcheck

Run R CMD check from R and collect the results
R
110
star
63

evaluate

A version of eval for R that returns more information about what happened
R
107
star
64

prettycode

Syntax highlight R code in the terminal
R
100
star
65

mockery

A mocking library for R.
R
99
star
66

sloop

S language OOP โ›ต๏ธ
R
98
star
67

pkgdepends

R Package Dependency Resolution
R
93
star
68

revdepcheck

R package reverse dependency checking
R
93
star
69

clock

A Date-Time Library for R
R
93
star
70

lifecycle

Manage the life cycle of your exported functions and arguments
R
91
star
71

systemfonts

System Native Font Handling in R
C++
90
star
72

gtable

The layout packages that powers ggplot2
R
85
star
73

askpass

Password Entry for R, Git, and SSH
R
83
star
74

rappdirs

Find OS-specific directories to store data, caches, and logs. A port of python's AppDirs
R
81
star
75

commonmark

High Performance CommonMark and Github Markdown Rendering in R
C
81
star
76

zip

Platform independent zip compression via miniz
C
81
star
77

downlit

Syntax Highlighting and Automatic Linking
R
80
star
78

clisymbols

Unicode symbols for CLI applications, with fallbacks
R
74
star
79

tree-sitter-r

C
74
star
80

ps

R package to query, list, manipulate system processes
C
72
star
81

sessioninfo

Print Session Information
R
72
star
82

pkgapi

Create a map of functions for an R package - WORK IN PROGRESS!
R
69
star
83

credentials

Tools for Managing SSH and Git Credentials
R
69
star
84

roxygen2md

Convert elements of roxygen documentation to markdown
R
69
star
85

sodium

R bindings to libsodium
R
68
star
86

backports

Reimplementations of Functions Introduced Since R-3.0.0
R
66
star
87

pkgbuild

Find tools needed to build R packages
R
65
star
88

cliapp

Rich Command Line Applications
R
62
star
89

webfakes

Fake web apps for HTTP testing R packages
C
61
star
90

generics

Common generic methods
R
60
star
91

diffviewer

HTML widget to visually compare files
JavaScript
57
star
92

pkgload

Simulate installing and loading a package
R
55
star
93

liteq

Serverless R message queue using SQLite
R
55
star
94

cachem

Key-value caches for R
R
54
star
95

carrier

Create standalone functions for remote execution
R
49
star
96

brio

Basic R Input Output
R
49
star
97

jose

Javascript Object Signing and Encryption for R
R
47
star
98

urlchecker

Run CRAN URL checks from older versions of R
R
46
star
99

pkgconfig

Private configuration for R packages
R
40
star
100

filelock

Cross platform file locking in R
R
39
star