Usage
withProgress(expr, min = 0, max = 1, value = min + (max - min) * 0.1,
message = NULL, detail = NULL, session = getDefaultReactiveDomain(),
env = parent.frame(), quoted = FALSE)setProgress(value = NULL, message = NULL, detail = NULL,
session = getDefaultReactiveDomain())
incProgress(amount = 0.1, message = NULL, detail = NULL,
session = getDefaultReactiveDomain())
Arguments
expr
The work to be done. This expression should contain calls to
setProgress
.
min
The value that represents the starting point of the progress bar.
Must be less tham max
. Default is 0.
max
The value that represents the end of the progress bar. Must be
greater than min
. Default is 1.
value
Single-element numeric vector; the value at which to set the
progress bar, relative to min
and max
. NULL
hides the
progress bar, if it is currently visible.
message
A single-element character vector; the message to be displayed
to the user, or NULL
to hide the current message (if any).
detail
A single-element character vector; the detail message to be
displayed to the user, or NULL
to hide the current detail message
(if any). The detail message will be shown with a de-emphasized appearance
relative to message
.
session
The Shiny session object, as provided by shinyServer
to
the server function. The default is to automatically find the session by
using the current reactive domain.
env
The environment in which expr
should be evaluated.
quoted
Whether expr
is a quoted expression (this is not
common).
amount
For incProgress
, the amount to increment the status bar.
Default is 0.1.