github/shiny
1
1
Fork 0
mirror of https://github.com/rstudio/shiny.git synced 2026-04-29 03:00:45 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
6d1515ef1147b1d2f896bca225dd4babbbf596a0
shiny/reference/runUrl.html
cpsievert 46e2efcbba cli-140-2703
2024-05-10 20:02:08 +00:00

188 lines
14 KiB
HTML
Raw Blame History

<!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 Shiny application from a URL — runUrl • 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.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 Shiny application from a URL — runUrl"><meta property="og:description" content="runUrl() downloads and launches a Shiny application that is hosted at
a downloadable URL. The Shiny application must be saved in a .zip, .tar, or
.tar.gz file. The Shiny application files must be contained in the root
directory or a subdirectory in the archive. For example, the files might be
myapp/server.r and myapp/ui.r. The functions runGitHub()
and runGist() are based on runUrl(), using URL's from GitHub
(https://github.com) and GitHub gists (https://gist.github.com),
respectively."><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.8.1.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>Run a Shiny application from a URL</h1>
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/HEAD/R/run-url.R" class="external-link"><code>R/run-url.R</code></a></small>
<div class="hidden name"><code>runUrl.Rd</code></div>
</div>
<div class="ref-description">
<p><code>runUrl()</code> downloads and launches a Shiny application that is hosted at
a downloadable URL. The Shiny application must be saved in a .zip, .tar, or
.tar.gz file. The Shiny application files must be contained in the root
directory or a subdirectory in the archive. For example, the files might be
<code>myapp/server.r</code> and <code>myapp/ui.r</code>. The functions <code>runGitHub()</code>
and <code>runGist()</code> are based on <code>runUrl()</code>, using URL's from GitHub
(<a href="https://github.com" class="external-link">https://github.com</a>) and GitHub gists (<a href="https://gist.github.com" class="external-link">https://gist.github.com</a>),
respectively.</p>
</div>
<div id="ref-usage">
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">runUrl</span><span class="op">(</span><span class="va">url</span>, filetype <span class="op">=</span> <span class="cn">NULL</span>, subdir <span class="op">=</span> <span class="cn">NULL</span>, destdir <span class="op">=</span> <span class="cn">NULL</span>, <span class="va">...</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">runGist</span><span class="op">(</span><span class="va">gist</span>, destdir <span class="op">=</span> <span class="cn">NULL</span>, <span class="va">...</span><span class="op">)</span></span>
<span></span>
<span><span class="fu">runGitHub</span><span class="op">(</span></span>
<span> <span class="va">repo</span>,</span>
<span> username <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">"github.user"</span><span class="op">)</span>,</span>
<span> ref <span class="op">=</span> <span class="st">"HEAD"</span>,</span>
<span> subdir <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> destdir <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span> <span class="va">...</span></span>
<span><span class="op">)</span></span></code></pre></div>
</div>
<div id="arguments">
<h2>Arguments</h2>
<dl><dt>url</dt>
<dd><p>URL of the application.</p></dd>
<dt>filetype</dt>
<dd><p>The file type (<code>".zip"</code>, <code>".tar"</code>, or
<code>".tar.gz"</code>. Defaults to the file extension taken from the url.</p></dd>
<dt>subdir</dt>
<dd><p>A subdirectory in the repository that contains the app. By
default, this function will run an app from the top level of the repo, but
you can use a path such as <code>"inst/shinyapp"</code>.</p></dd>
<dt>destdir</dt>
<dd><p>Directory to store the downloaded application files. If <code>NULL</code>
(the default), the application files will be stored in a temporary directory
and removed when the app exits</p></dd>
<dt>...</dt>
<dd><p>Other arguments to be passed to <code><a href="runApp.html">runApp()</a></code>, such as
<code>port</code> and <code>launch.browser</code>.</p></dd>
<dt>gist</dt>
<dd><p>The identifier of the gist. For example, if the gist is
https://gist.github.com/jcheng5/3239667, then <code>3239667</code>,
<code>'3239667'</code>, and <code>'https://gist.github.com/jcheng5/3239667'</code> are
all valid values.</p></dd>
<dt>repo</dt>
<dd><p>Name of the repository.</p></dd>
<dt>username</dt>
<dd><p>GitHub username. If <code>repo</code> is of the form
<code>"username/repo"</code>, <code>username</code> will be taken from <code>repo</code>.</p></dd>
<dt>ref</dt>
<dd><p>Desired git reference. Could be a commit, tag, or branch name.
Defaults to <code>"HEAD"</code>, which means the default branch on GitHub, typically
<code>"main"</code> or <code>"master"</code>.</p></dd>
</dl></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 this example 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">runUrl</span><span class="op">(</span><span class="st">'https://github.com/rstudio/shiny_example/archive/main.tar.gz'</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span> <span class="co"># Can run an app from a subdirectory in the archive</span></span></span>
<span class="r-in"><span> <span class="fu">runUrl</span><span class="op">(</span><span class="st">"https://github.com/rstudio/shiny_example/archive/main.zip"</span>,</span></span>
<span class="r-in"><span> subdir <span class="op">=</span> <span class="st">"inst/shinyapp/"</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="co">## Only run this example 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">runGist</span><span class="op">(</span><span class="fl">3239667</span><span class="op">)</span></span></span>
<span class="r-in"><span> <span class="fu">runGist</span><span class="op">(</span><span class="st">"https://gist.github.com/jcheng5/3239667"</span><span class="op">)</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span> <span class="co"># Old URL format without username</span></span></span>
<span class="r-in"><span> <span class="fu">runGist</span><span class="op">(</span><span class="st">"https://gist.github.com/3239667"</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="co">## Only run this example 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">runGitHub</span><span class="op">(</span><span class="st">"shiny_example"</span>, <span class="st">"rstudio"</span><span class="op">)</span></span></span>
<span class="r-in"><span> <span class="co"># or runGitHub("rstudio/shiny_example")</span></span></span>
<span class="r-in"><span></span></span>
<span class="r-in"><span> <span class="co"># Can run an app from a subdirectory in the repo</span></span></span>
<span class="r-in"><span> <span class="fu">runGitHub</span><span class="op">(</span><span class="st">"shiny_example"</span>, <span class="st">"rstudio"</span>, subdir <span class="op">=</span> <span class="st">"inst/shinyapp/"</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, 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.0.9.</p>
</div>
</footer></div>
</body></html>
Reference in New Issue View Git Blame Copy Permalink