mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
232 lines
16 KiB
HTML
232 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Reporting progress (functional API) — withProgress • shiny</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Reporting progress (functional API) — withProgress"><meta property="og:description" content="Reports progress to the user during long-running operations."><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]--></head><body data-spy="scroll" data-target="#toc">
|
|
|
|
|
|
<div class="container template-reference-topic">
|
|
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">shiny</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.7.3.9001</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav"><li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul><ul class="nav navbar-nav navbar-right"><li>
|
|
<a href="https://github.com/rstudio/shiny/" class="external-link">
|
|
<span class="fab fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul></div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
|
|
</header><div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Reporting progress (functional API)</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/HEAD/R/progress.R" class="external-link"><code>R/progress.R</code></a></small>
|
|
<div class="hidden name"><code>withProgress.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>Reports progress to the user during long-running operations.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">withProgress</span><span class="op">(</span></span>
|
|
<span> <span class="va">expr</span>,</span>
|
|
<span> min <span class="op">=</span> <span class="fl">0</span>,</span>
|
|
<span> max <span class="op">=</span> <span class="fl">1</span>,</span>
|
|
<span> value <span class="op">=</span> <span class="va">min</span> <span class="op">+</span> <span class="op">(</span><span class="va">max</span> <span class="op">-</span> <span class="va">min</span><span class="op">)</span> <span class="op">*</span> <span class="fl">0.1</span>,</span>
|
|
<span> message <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> detail <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> style <span class="op">=</span> <span class="fu"><a href="shinyOptions.html">getShinyOption</a></span><span class="op">(</span><span class="st">"progress.style"</span>, default <span class="op">=</span> <span class="st">"notification"</span><span class="op">)</span>,</span>
|
|
<span> session <span class="op">=</span> <span class="fu"><a href="domains.html">getDefaultReactiveDomain</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
|
<span> env <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/sys.parent.html" class="external-link">parent.frame</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
|
<span> quoted <span class="op">=</span> <span class="cn">FALSE</span></span>
|
|
<span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">setProgress</span><span class="op">(</span></span>
|
|
<span> value <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> message <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> detail <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> session <span class="op">=</span> <span class="fu"><a href="domains.html">getDefaultReactiveDomain</a></span><span class="op">(</span><span class="op">)</span></span>
|
|
<span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">incProgress</span><span class="op">(</span></span>
|
|
<span> amount <span class="op">=</span> <span class="fl">0.1</span>,</span>
|
|
<span> message <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> detail <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> session <span class="op">=</span> <span class="fu"><a href="domains.html">getDefaultReactiveDomain</a></span><span class="op">(</span><span class="op">)</span></span>
|
|
<span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<h2>Arguments</h2>
|
|
<dl><dt>expr</dt>
|
|
<dd><p>The work to be done. This expression should contain calls to
|
|
<code>setProgress()</code> or <code>incProgress()</code>.</p></dd>
|
|
|
|
|
|
<dt>min</dt>
|
|
<dd><p>The value that represents the starting point of the progress bar.
|
|
Must be less tham <code>max</code>. Default is 0.</p></dd>
|
|
|
|
|
|
<dt>max</dt>
|
|
<dd><p>The value that represents the end of the progress bar. Must be
|
|
greater than <code>min</code>. Default is 1.</p></dd>
|
|
|
|
|
|
<dt>value</dt>
|
|
<dd><p>Single-element numeric vector; the value at which to set the
|
|
progress bar, relative to <code>min</code> and <code>max</code>.</p></dd>
|
|
|
|
|
|
<dt>message</dt>
|
|
<dd><p>A single-element character vector; the message to be displayed
|
|
to the user, or <code>NULL</code> to hide the current message (if any).</p></dd>
|
|
|
|
|
|
<dt>detail</dt>
|
|
<dd><p>A single-element character vector; the detail message to be
|
|
displayed to the user, or <code>NULL</code> to hide the current detail message
|
|
(if any). The detail message will be shown with a de-emphasized appearance
|
|
relative to <code>message</code>.</p></dd>
|
|
|
|
|
|
<dt>style</dt>
|
|
<dd><p>Progress display style. If <code>"notification"</code> (the default),
|
|
the progress indicator will show using Shiny's notification API. If
|
|
<code>"old"</code>, use the same HTML and CSS used in Shiny 0.13.2 and below
|
|
(this is for backward-compatibility).</p></dd>
|
|
|
|
|
|
<dt>session</dt>
|
|
<dd><p>The Shiny session object, as provided by <code>shinyServer</code> to
|
|
the server function. The default is to automatically find the session by
|
|
using the current reactive domain.</p></dd>
|
|
|
|
|
|
<dt>env</dt>
|
|
<dd><p>The environment in which <code>expr</code> should be evaluated.</p></dd>
|
|
|
|
|
|
<dt>quoted</dt>
|
|
<dd><p>Whether <code>expr</code> is a quoted expression (this is not
|
|
common).</p></dd>
|
|
|
|
|
|
<dt>amount</dt>
|
|
<dd><p>For <code>incProgress</code>, the amount to increment the status bar.
|
|
Default is 0.1.</p></dd>
|
|
|
|
</dl></div>
|
|
<div id="value">
|
|
<h2>Value</h2>
|
|
|
|
|
|
<p>The result of <code>expr</code>.</p>
|
|
</div>
|
|
<div id="details">
|
|
<h2>Details</h2>
|
|
<p>This package exposes two distinct programming APIs for working with progress.
|
|
Using <code>withProgress</code> with <code>incProgress</code> or <code>setProgress</code>
|
|
provide a simple function-based interface, while the <code><a href="Progress.html">Progress()</a></code>
|
|
reference class provides an object-oriented API.</p>
|
|
<p>Use <code>withProgress</code> 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</code> or <code>setProgress</code> are called. When <code>withProgress</code>
|
|
exits, the corresponding progress panel will be removed.</p>
|
|
<p>The <code>incProgress</code> function increments the status bar by a specified
|
|
amount, whereas the <code>setProgress</code> function sets it to a specific value,
|
|
and can also set the text displayed.</p>
|
|
<p>Generally, <code>withProgress</code>/<code>incProgress</code>/<code>setProgress</code> 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</code> reference class.</p>
|
|
<p>As of version 0.14, the progress indicators use Shiny's new notification API.
|
|
If you want to use the old styling (for example, you may have used customized
|
|
CSS), you can use <code>style="old"</code> each time you call
|
|
<code>withProgress()</code>. If you don't want to set the style each time
|
|
<code>withProgress</code> is called, you can instead call
|
|
<code><a href="shinyOptions.html">shinyOptions(progress.style="old")</a></code> just once, inside the server
|
|
function.</p>
|
|
</div>
|
|
<div id="see-also">
|
|
<h2>See also</h2>
|
|
<div class="dont-index"><p><code><a href="Progress.html">Progress()</a></code></p></div>
|
|
</div>
|
|
|
|
<div id="ref-examples">
|
|
<h2>Examples</h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="co">## Only run examples in interactive R sessions</span></span></span>
|
|
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/interactive.html" class="external-link">interactive</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">options</a></span><span class="op">(</span>device.ask.default <span class="op">=</span> <span class="cn">FALSE</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="va">ui</span> <span class="op"><-</span> <span class="fu"><a href="fluidPage.html">fluidPage</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="plotOutput.html">plotOutput</a></span><span class="op">(</span><span class="st">"plot"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="va">server</span> <span class="op"><-</span> <span class="kw">function</span><span class="op">(</span><span class="va">input</span>, <span class="va">output</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="va">output</span><span class="op">$</span><span class="va">plot</span> <span class="op"><-</span> <span class="fu"><a href="renderPlot.html">renderPlot</a></span><span class="op">(</span><span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">withProgress</span><span class="op">(</span>message <span class="op">=</span> <span class="st">'Calculation in progress'</span>,</span></span>
|
|
<span class="r-in"><span> detail <span class="op">=</span> <span class="st">'This may take a while...'</span>, value <span class="op">=</span> <span class="fl">0</span>, <span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="kw">for</span> <span class="op">(</span><span class="va">i</span> <span class="kw">in</span> <span class="fl">1</span><span class="op">:</span><span class="fl">15</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">incProgress</span><span class="op">(</span><span class="fl">1</span><span class="op">/</span><span class="fl">15</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">0.25</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">}</span></span></span>
|
|
<span class="r-in"><span> <span class="op">}</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="https://rdrr.io/r/graphics/plot.default.html" class="external-link">plot</a></span><span class="op">(</span><span class="va">cars</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">}</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="op">}</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="fu"><a href="shinyApp.html">shinyApp</a></span><span class="op">(</span><span class="va">ui</span>, <span class="va">server</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span><span class="op">}</span></span></span>
|
|
</code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
|
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
|
|
</nav></div>
|
|
</div>
|
|
|
|
|
|
<footer><div class="copyright">
|
|
<p></p><p>Developed by Winston Chang, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, Barbara Borges.</p>
|
|
</div>
|
|
|
|
<div class="pkgdown">
|
|
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.6.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|