mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
146 lines
10 KiB
HTML
146 lines
10 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>Run a gadget — runGadget • shiny</title><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js" integrity="sha512-v2CJ7UaYy4JwqLDIrZUI/4hqeoQieOmAZNXBeQyjo21dadnwR+8ZaIJVT8EE2iyI61OV8e6M8PP2/4hpQINQ/g==" crossorigin="anonymous" referrerpolicy="no-referrer"></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="Run a gadget — runGadget"><meta property="og:description" content="Similar to runApp, but handles input$cancel automatically, and
|
||
if running in RStudio, defaults to viewing the app in the Viewer pane."><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.11.1.9000</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>Run a gadget</h1>
|
||
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/main/R/runapp.R" class="external-link"><code>R/runapp.R</code></a></small>
|
||
<div class="hidden name"><code>runGadget.Rd</code></div>
|
||
</div>
|
||
|
||
<div class="ref-description">
|
||
<p>Similar to <code>runApp</code>, but handles <code>input$cancel</code> automatically, and
|
||
if running in RStudio, defaults to viewing the app in the Viewer pane.</p>
|
||
</div>
|
||
|
||
<div id="ref-usage">
|
||
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">runGadget</span><span class="op">(</span></span>
|
||
<span> <span class="va">app</span>,</span>
|
||
<span> server <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
||
<span> port <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/options.html" class="external-link">getOption</a></span><span class="op">(</span><span class="st">"shiny.port"</span><span class="op">)</span>,</span>
|
||
<span> viewer <span class="op">=</span> <span class="fu"><a href="viewer.html">paneViewer</a></span><span class="op">(</span><span class="op">)</span>,</span>
|
||
<span> stopOnCancel <span class="op">=</span> <span class="cn">TRUE</span></span>
|
||
<span><span class="op">)</span></span></code></pre></div>
|
||
</div>
|
||
|
||
<div id="arguments">
|
||
<h2>Arguments</h2>
|
||
|
||
|
||
<dl><dt id="arg-app">app<a class="anchor" aria-label="anchor" href="#arg-app"></a></dt>
|
||
<dd><p>Either a Shiny app object as created by
|
||
<code><a href="shiny-package.html">shinyApp()</a></code> et al, or, a UI object.</p></dd>
|
||
|
||
|
||
<dt id="arg-server">server<a class="anchor" aria-label="anchor" href="#arg-server"></a></dt>
|
||
<dd><p>Ignored if <code>app</code> is a Shiny app object; otherwise, passed
|
||
along to <code>shinyApp</code> (i.e. <code>shinyApp(ui = app, server = server)</code>).</p></dd>
|
||
|
||
|
||
<dt id="arg-port">port<a class="anchor" aria-label="anchor" href="#arg-port"></a></dt>
|
||
<dd><p>See <code><a href="shiny-package.html">runApp()</a></code>.</p></dd>
|
||
|
||
|
||
<dt id="arg-viewer">viewer<a class="anchor" aria-label="anchor" href="#arg-viewer"></a></dt>
|
||
<dd><p>Specify where the gadget should be displayed–viewer pane,
|
||
dialog window, or external browser–by passing in a call to one of the
|
||
<code><a href="viewer.html">viewer()</a></code> functions.</p></dd>
|
||
|
||
|
||
<dt id="arg-stoponcancel">stopOnCancel<a class="anchor" aria-label="anchor" href="#arg-stoponcancel"></a></dt>
|
||
<dd><p>If <code>TRUE</code> (the default), then an <code>observeEvent</code>
|
||
is automatically created that handles <code>input$cancel</code> by calling
|
||
<code><a href="stopApp.html">stopApp()</a></code> with an error. Pass <code>FALSE</code> if you want to handle
|
||
<code>input$cancel</code> yourself.</p></dd>
|
||
|
||
</dl></div>
|
||
<div id="value">
|
||
<h2>Value</h2>
|
||
<p>The value returned by the gadget.</p>
|
||
</div>
|
||
|
||
<div id="ref-examples">
|
||
<h2>Examples</h2>
|
||
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span> <span class="co"># \dontrun{</span></span></span>
|
||
<span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://shiny.posit.co/" class="external-link">shiny</a></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="fillPage.html">fillPage</a></span><span class="op">(</span><span class="va">...</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="va">session</span><span class="op">)</span> <span class="op">{</span></span></span>
|
||
<span class="r-in"><span> <span class="va">...</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="co"># Either pass ui/server as separate arguments...</span></span></span>
|
||
<span class="r-in"><span><span class="fu">runGadget</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></span>
|
||
<span class="r-in"><span><span class="co"># ...or as a single app object</span></span></span>
|
||
<span class="r-in"><span><span class="fu">runGadget</span><span class="op">(</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 class="op">)</span></span></span>
|
||
<span class="r-in"><span><span class="op">}</span> <span class="co"># }</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, Posit Software, PBC.</p>
|
||
</div>
|
||
|
||
<div class="pkgdown">
|
||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.1.3.</p>
|
||
</div>
|
||
|
||
</footer></div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body></html>
|
||
|