winProgressBar {utils} | R Documentation |
Put up a Windows progress bar widget, update and access it.
winProgressBar(title = "R progress bar", label = "", min = 0, max = 1, initial = 0, width = 300) getWinProgressBar(pb) setWinProgressBar(pb, value, title = NULL, label = NULL) ## S3 method for class 'winProgressBar' close(con, ...)
title, label |
character strings, giving the window title and the label on the dialog box respectively. |
min, max |
(finite) numeric values for the extremes of the progress bar. |
initial, value |
initial or new value for the progress bar. |
width |
the width of the progress bar in pixels: the dialog box will be 40 pixels wider (plus frame). |
pb, con |
an object of class |
... |
for consistency with the generic. |
winProgressBar
will display a progress bar centred on the
screen. Space will be allocated for the label only if it is non-empty.
setWinProgessBar
will update the value and for non-NULL
values, the title and label (provided there was one when the widget
was created). Missing (NA
) and out-of-range values of
value
will be (silently) ignored.
The progress bar should be close
d when finished with, but it
will be garbage-collected once no R object refers to it.
For winProgressBar
an object of class "winProgressBar"
.
For getWinProgressBar
and setWinProgressBar
, a
length-one numeric vector giving the previous value (invisibly for
setWinProgressBar
).
These functions are only available on Windows.
On all platforms,
txtProgressBar
, tkProgressBar
pb <- winProgressBar("test progress bar", "Some information in %", 0, 100, 50) Sys.sleep(0.5) u <- c(0, sort(runif(20, 0, 100)), 100) for(i in u) { Sys.sleep(0.1) info <- sprintf("%d%% done", round(i)) setWinProgressBar(pb, i, sprintf("test (%s)", info), info) } Sys.sleep(5) close(pb)