mirror of
https://github.com/rstudio/shiny.git
synced 2026-02-03 11:15:07 -05:00
96 lines
3.4 KiB
R
96 lines
3.4 KiB
R
% Generated by roxygen2 (4.0.2): do not edit by hand
|
|
\name{withProgress}
|
|
\alias{incProgress}
|
|
\alias{setProgress}
|
|
\alias{withProgress}
|
|
\title{Reporting progress (functional API)}
|
|
\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{
|
|
\item{expr}{The work to be done. This expression should contain calls to
|
|
\code{setProgress}.}
|
|
|
|
\item{min}{The value that represents the starting point of the progress bar.
|
|
Must be less tham \code{max}. Default is 0.}
|
|
|
|
\item{max}{The value that represents the end of the progress bar. Must be
|
|
greater than \code{min}. Default is 1.}
|
|
|
|
\item{value}{Single-element numeric vector; the value at which to set the
|
|
progress bar, relative to \code{min} and \code{max}. \code{NULL} hides the
|
|
progress bar, if it is currently visible.}
|
|
|
|
\item{message}{A single-element character vector; the message to be displayed
|
|
to the user, or \code{NULL} to hide the current message (if any).}
|
|
|
|
\item{detail}{A single-element character vector; the detail message to be
|
|
displayed to the user, or \code{NULL} to hide the current detail message
|
|
(if any). The detail message will be shown with a de-emphasized appearance
|
|
relative to \code{message}.}
|
|
|
|
\item{session}{The Shiny session object, as provided by \code{shinyServer} to
|
|
the server function. The default is to automatically find the session by
|
|
using the current reactive domain.}
|
|
|
|
\item{env}{The environment in which \code{expr} should be evaluated.}
|
|
|
|
\item{quoted}{Whether \code{expr} is a quoted expression (this is not
|
|
common).}
|
|
|
|
\item{amount}{For \code{incProgress}, the amount to increment the status bar.
|
|
Default is 0.1.}
|
|
}
|
|
\description{
|
|
Reports progress to the user during long-running operations.
|
|
}
|
|
\details{
|
|
This package exposes two distinct programming APIs for working with progress.
|
|
Using \code{withProgress} with \code{incProgress} or \code{setProgress}
|
|
provide a simple function-based interface, while the \code{\link{Progress}}
|
|
reference class provides an object-oriented API.
|
|
|
|
Use \code{withProgress} to wrap the scope of your work; doing so will cause a
|
|
new progress panel to be created, and it will be displayed the first time
|
|
\code{incProgress} or \code{setProgress} are called. When \code{withProgress}
|
|
exits, the corresponding progress panel will be removed.
|
|
|
|
The \code{incProgress} function increments the status bar by a specified
|
|
amount, whereas the \code{setProgress} function sets it to a specific value,
|
|
and can also set the text displayed.
|
|
|
|
Generally, \code{withProgress}/\code{incProgress}/\code{setProgress} should
|
|
be sufficient; the exception is if the work to be done is asynchronous (this
|
|
is not common) or otherwise cannot be encapsulated by a single scope. In that
|
|
case, you can use the \code{Progress} reference class.
|
|
}
|
|
\examples{
|
|
\dontrun{
|
|
# server.R
|
|
shinyServer(function(input, output) {
|
|
output$plot <- renderPlot({
|
|
withProgress(message = 'Calculation in progress',
|
|
detail = 'This may take a while...', value = 0, {
|
|
for (i in 1:15) {
|
|
incProgress(1/15)
|
|
Sys.sleep(0.25)
|
|
}
|
|
})
|
|
plot(cars)
|
|
})
|
|
})
|
|
}
|
|
}
|
|
\seealso{
|
|
\code{\link{Progress}}
|
|
}
|
|
|