mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
229 lines
15 KiB
HTML
229 lines
15 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>Web Application Framework for R • 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="Web Application Framework for R">
|
||
<meta property="og:description" content='Makes it incredibly easy to build interactive web applications with R. Automatic "reactive" binding between inputs and outputs and extensive prebuilt widgets make it possible to build beautiful, responsive, and powerful applications with minimal effort.'>
|
||
<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-home">
|
||
<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.12.1</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="contents col-md-9">
|
||
<div class="section level1">
|
||
<div class="page-header"><h1 id="shiny-">shiny <img src="reference/figures/logo.png" align="right" width="120" height="139" alt=""><a class="anchor" aria-label="anchor" href="#shiny-"></a>
|
||
</h1></div>
|
||
<!-- badges: start -->
|
||
|
||
<!-- badges: end -->
|
||
<p>Easily build rich and productive interactive web apps in R — no HTML/CSS/JavaScript required.</p>
|
||
<div class="section level2">
|
||
<h2 id="features">Features<a class="anchor" aria-label="anchor" href="#features"></a>
|
||
</h2>
|
||
<ul>
|
||
<li>An intuitive and extensible <a href="https://en.wikipedia.org/wiki/Reactive_programming" class="external-link">reactive programming</a> model which makes it easy to transform existing R code into a “live app” where outputs automatically react to new user input.
|
||
<ul>
|
||
<li>Compared to event-based programming, reactivity allows Shiny to do the minimum amount of work when input(s) change, and allows humans to more easily reason about complex <a href="https://en.wikipedia.org/wiki/Model%E2%80%93view%E2%80%93controller" class="external-link">MVC logic</a>.</li>
|
||
</ul>
|
||
</li>
|
||
<li>A prebuilt set of highly sophisticated, customizable, and easy-to-use widgets (e.g., plots, tables, sliders, dropdowns, date pickers, and more).</li>
|
||
<li>An attractive default look based on <a href="https://getbootstrap.com/" class="external-link">Bootstrap</a> which can also be easily customized with the <a href="https://github.com/rstudio/bslib" class="external-link">bslib</a> package or avoided entirely with more direct R bindings to HTML/CSS/JavaScript.</li>
|
||
<li>Seamless integration with <a href="https://shiny.rstudio.com/articles/interactive-docs.html" class="external-link">R Markdown</a>, making it easy to embed numerous applications natively within a larger dynamic document.</li>
|
||
<li>Tools for improving and monitoring performance, including native support for <a href="https://posit.co/blog/shiny-1-1-0/" class="external-link">async programming</a>, <a href="https://talks.cpsievert.me/20201117" class="external-link">caching</a>, <a href="https://rstudio.github.io/shinyloadtest/" class="external-link">load testing</a>, and more.</li>
|
||
<li>
|
||
<a href="https://shiny.rstudio.com/articles/modules.html" class="external-link">Modules</a>: a framework for reducing code duplication and complexity.</li>
|
||
<li>An ability to <a href="https://shiny.rstudio.com/articles/bookmarking-state.html" class="external-link">bookmark application state</a> and/or <a href="https://github.com/rstudio/shinymeta" class="external-link">generate code to reproduce output(s)</a>.</li>
|
||
<li>A rich ecosystem of extension packages for more <a href="http://www.htmlwidgets.org/" class="external-link">custom widgets</a>, <a href="https://github.com/rstudio/shinyvalidate" class="external-link">input validation</a>, <a href="https://github.com/rstudio/shinytest" class="external-link">unit testing</a>, and more.</li>
|
||
</ul>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="installation">Installation<a class="anchor" aria-label="anchor" href="#installation"></a>
|
||
</h2>
|
||
<p>To install the stable version from CRAN:</p>
|
||
<div class="sourceCode" id="cb1"><pre class="downlit sourceCode r">
|
||
<code class="sourceCode R"><span><span class="fu"><a href="https://rdrr.io/r/utils/install.packages.html" class="external-link">install.packages</a></span><span class="op">(</span><span class="st">"shiny"</span><span class="op">)</span></span></code></pre></div>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="getting-started">Getting Started<a class="anchor" aria-label="anchor" href="#getting-started"></a>
|
||
</h2>
|
||
<p>Once installed, load the library and run an example:</p>
|
||
<div class="sourceCode" id="cb2"><pre class="downlit sourceCode r">
|
||
<code class="sourceCode R"><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="co"># Launches an app, with the app's source code included</span></span>
|
||
<span><span class="fu"><a href="reference/runExample.html">runExample</a></span><span class="op">(</span><span class="st">"06_tabsets"</span><span class="op">)</span></span>
|
||
<span><span class="co"># Lists more prepackaged examples</span></span>
|
||
<span><span class="fu"><a href="reference/runExample.html">runExample</a></span><span class="op">(</span><span class="op">)</span></span></code></pre></div>
|
||
<p>For more examples and inspiration, check out the <a href="https://shiny.rstudio.com/gallery/" class="external-link">Shiny User Gallery</a>.</p>
|
||
<p>For help with learning fundamental Shiny programming concepts, check out the <a href="https://mastering-shiny.org/" class="external-link">Mastering Shiny</a> book and the <a href="https://shiny.rstudio.com/tutorial/" class="external-link">Shiny Tutorial</a>. The former is currently more up-to-date with modern Shiny features, whereas the latter takes a deeper, more visual, dive into fundamental concepts.</p>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="join-the-conversation">Join the conversation<a class="anchor" aria-label="anchor" href="#join-the-conversation"></a>
|
||
</h2>
|
||
<p>If you want to chat about Shiny, meet other developers, or help us decide what to work on next, <a href="https://discord.com/invite/yMGCamUMnS" class="external-link">join us on Discord</a>.</p>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="getting-help">Getting Help<a class="anchor" aria-label="anchor" href="#getting-help"></a>
|
||
</h2>
|
||
<p>To ask a question about Shiny, please use the <a href="https://forum.posit.co/new-topic?category=shiny&tags=shiny" class="external-link">RStudio Community website</a>.</p>
|
||
<p>For bug reports, please use the <a href="https://github.com/rstudio/shiny/issues" class="external-link">issue tracker</a> and also keep in mind that by <a href="https://github.com/rstudio/shiny/wiki/Writing-Good-Bug-Reports" class="external-link">writing a good bug report</a>, you’re more likely to get help with your problem.</p>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="contributing">Contributing<a class="anchor" aria-label="anchor" href="#contributing"></a>
|
||
</h2>
|
||
<p>We welcome contributions to the <strong>shiny</strong> package. Please see our <a href="https://github.com/rstudio/shiny/blob/main/.github/CONTRIBUTING.md" class="external-link">CONTRIBUTING.md</a> file for detailed guidelines of how to contribute.</p>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="license">License<a class="anchor" aria-label="anchor" href="#license"></a>
|
||
</h2>
|
||
<p>The shiny package as a whole is licensed under the GPLv3. See the <a href="LICENSE">LICENSE</a> file for more details.</p>
|
||
</div>
|
||
<div class="section level2">
|
||
<h2 id="r-version-support">R version support<a class="anchor" aria-label="anchor" href="#r-version-support"></a>
|
||
</h2>
|
||
<p>Shiny is supported on the latest release version of R, as well as the previous four minor release versions of R. For example, if the latest release R version is 4.3, then that version is supported, as well as 4.2, 4.1, 4.0, 3.6.</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
||
<div class="links">
|
||
<h2 data-toc-skip>Links</h2>
|
||
<ul class="list-unstyled">
|
||
<li><a href="https://cloud.r-project.org/package=shiny" class="external-link">View on CRAN</a></li>
|
||
<li><a href="https://github.com/rstudio/shiny/" class="external-link">Browse source code</a></li>
|
||
<li><a href="https://github.com/rstudio/shiny/issues" class="external-link">Report a bug</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="license">
|
||
<h2 data-toc-skip>License</h2>
|
||
<ul class="list-unstyled">
|
||
<li>
|
||
<a href="https://www.r-project.org/Licenses/GPL-3" class="external-link">GPL-3</a> | file <a href="LICENSE-text.html">LICENSE</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="community">
|
||
<h2 data-toc-skip>Community</h2>
|
||
<ul class="list-unstyled">
|
||
<li><a href="CONTRIBUTING.html">Contributing guide</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="citation">
|
||
<h2 data-toc-skip>Citation</h2>
|
||
<ul class="list-unstyled">
|
||
<li><a href="authors.html#citation">Citing shiny</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="developers">
|
||
<h2 data-toc-skip>Developers</h2>
|
||
<ul class="list-unstyled">
|
||
<li>Winston Chang <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0002-1576-2126" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
|
||
<li>Joe Cheng <br><small class="roles"> Author </small> </li>
|
||
<li>JJ Allaire <br><small class="roles"> Author </small> </li>
|
||
<li>Carson Sievert <br><small class="roles"> Author, maintainer </small> <a href="https://orcid.org/0000-0002-4958-2844" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
|
||
<li>Barret Schloerke <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0001-9986-114X" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
|
||
<li>Garrick Aden-Buie <br><small class="roles"> Author </small> <a href="https://orcid.org/0000-0002-7111-0077" target="orcid.widget" aria-label="ORCID" class="external-link"><span class="fab fa-orcid orcid" aria-hidden="true"></span></a> </li>
|
||
<li>Yihui Xie <br><small class="roles"> Author </small> </li>
|
||
<li>Jeff Allen <br><small class="roles"> Author </small> </li>
|
||
<li>Jonathan McPherson <br><small class="roles"> Author </small> </li>
|
||
<li>Alan Dipert <br><small class="roles"> Author </small> </li>
|
||
<li>Barbara Borges <br><small class="roles"> Author </small> </li>
|
||
<li>Posit Software, PBC <br><small class="roles"> Copyright holder, funder </small> <a href="https://ror.org/03wc8by49" class="external-link"><img src="https://raw.githubusercontent.com/ror-community/ror-logos/main/ror-icon-rgb.svg" class="ror" alt="ROR"></a> </li>
|
||
<li><a href="authors.html">More about authors...</a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
<div class="dev-status">
|
||
<h2 data-toc-skip>Dev status</h2>
|
||
<ul class="list-unstyled">
|
||
<li><a href="https://CRAN.R-project.org/package=shiny" class="external-link"><img src="https://www.r-pkg.org/badges/version/shiny" alt="CRAN"></a></li>
|
||
<li><a href="https://github.com/rstudio/shiny/actions" class="external-link"><img src="https://github.com/rstudio/shiny/actions/workflows/R-CMD-check.yaml/badge.svg" alt="R build status"></a></li>
|
||
<li><a href="https://forum.posit.co/new-topic?category=shiny&tags=shiny" class="external-link"><img src="https://img.shields.io/badge/community-shiny-blue?style=social&logo=rstudio&logoColor=75AADB" alt="RStudio community"></a></li>
|
||
</ul>
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<footer><div class="copyright">
|
||
<p></p>
|
||
<p>Developed by Winston Chang, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Garrick Aden-Buie, 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.2.0.</p>
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html>
|