Learn R Programming
⚠️There's a newer version (1.10.0) of this package.Take me there.

Shiny

Travis:

AppVeyor:

Shiny is a new package from RStudio that makes it incredibly easy to build interactive web applications with R.

For an introduction and examples, visit the Shiny Dev Center.

If you have general questions about using Shiny, please use the RStudio Community website. For bug reports, please use the issue tracker.

Features

  • Build useful web applications with only a few lines of code—no JavaScript required.
  • Shiny applications are automatically "live" in the same way that spreadsheets are live. Outputs change instantly as users modify inputs, without requiring a reload of the browser.
  • Shiny user interfaces can be built entirely using R, or can be written directly in HTML, CSS, and JavaScript for more flexibility.
  • Works in any R environment (Console R, Rgui for Windows or Mac, ESS, StatET, RStudio, etc.).
  • Attractive default UI theme based on Bootstrap.
  • A highly customizable slider widget with built-in support for animation.
  • Prebuilt output widgets for displaying plots, tables, and printed output of R objects.
  • Fast bidirectional communication between the web browser and R using the httpuv package.
  • Uses a reactive programming model that eliminates messy event handling code, so you can focus on the code that really matters.
  • Develop and redistribute your own Shiny widgets that other developers can easily drop into their own applications (coming soon!).

Installation

To install the stable version from CRAN, simply run the following from an R console:

install.packages("shiny")

To install the latest development builds directly from GitHub, run this instead:

if (!require("devtools"))
  install.packages("devtools")
devtools::install_github("rstudio/shiny")

Getting Started

To learn more we highly recommend you check out the Shiny Tutorial. The tutorial explains the framework in-depth, walks you through building a simple application, and includes extensive annotated examples.

Bootstrap 3 migration

Shiny versions 0.10.2.2 and below used the Bootstrap 2 web framework. After 0.10.2.2, Shiny switched to Bootstrap 3. For most users, the upgrade should be seamless. However, if you have have customized your HTML-generating code to use features specific to Bootstrap 2, you may need to update your code to work with Bootstrap 3.

If you do not wish to update your code at this time, you can use the shinybootstrap2 package for backward compatibility.

If you prefer to install an older version of Shiny, you can do it using the devtools package:

devtools::install_version("shiny", version = "0.10.2.2")

Development notes

The Javascript code in Shiny is minified using tools that run on Node.js. See the tools/ directory for more information.

Guidelines for contributing

We welcome contributions to the shiny package. Please see our CONTRIBUTING.md file for detailed guidelines of how to contribute.

License

The shiny package as a whole is licensed under the GPLv3. See the LICENSE file for more details.

Copy Link

Version

Install

install.packages('shiny')

Monthly Downloads

554,825

Version

1.3.2

License

GPL-3 | file LICENSE

Maintainer

Winston Chang

Last Published

April 22nd, 2019

Functions in shiny (1.3.2)

HTML

Mark Characters as HTML
NS

Namespaced IDs for inputs/outputs
builder

HTML Builder Functions
callModule

Invoke a Shiny module
dateRangeInput

Create date range input
dblclickOpts

Create an object representing double-click options
actionButton

Action button/link
fluidPage

Create a page with fluid layout
flowLayout

Flow layout
addResourcePath

Resource Publishing
getQueryString

Get the query string / hash component from the URL
key_missing

A Key Missing object
headerPanel

Create a header panel
clickOpts

Create an object representing click options
knitr_methods

Knitr S3 methods
makeReactiveBinding

Make a reactive variable
column

Create a column within a UI definition
markOutputAttrs

Mark a render function with attributes that will be used by the output
absolutePanel

Panel with absolute positioning
Progress

Reporting progress (object-oriented API)
conditionalPanel

Conditional Panel
createRenderFunction

Implement render functions
checkboxGroupInput

Checkbox Group Input Control
numericInput

Create a numeric input control
bootstrapLib

Bootstrap libraries
bootstrapPage

Create a Bootstrap page
debounce

Slow down a reactive expression with debounce/throttle
diskCache

Create a disk cache object
exportTestValues

Register expressions for export in test mode
observe

Create a reactive observer
helpText

Create a help text element
exprToFunction

Convert an expression to a function
hoverOpts

Create an object representing hover options
brushedPoints

Find rows of data that are selected by a brush
downloadHandler

File Downloads
brushOpts

Create an object representing brushing options
isRunning

Check whether a Shiny application is running
checkboxInput

Checkbox Input Control
createWebDependency

Create a web dependency
plotOutput

Create an plot or image output element
parseQueryString

Parse a GET query string from a URL
isolate

Create a non-reactive scope for an expression
reactiveVal

Create a (single) reactive value
passwordInput

Create a password input control
reactiveValues

Create an object for storing reactive values
renderUI

UI Output
dateInput

Create date input
applyInputHandlers

Apply input handlers to raw input values
repeatable

Make a random number generator repeatable
freezeReactiveVal

Freeze a reactive value
getCurrentOutputInfo

Get information about the output that is currently being executed.
insertUI

Insert UI objects
domains

Reactive domains
enableBookmarking

Enable bookmarking for a Shiny application
runApp

Run Shiny Application
fileInput

File Upload Control
fillPage

Create a page that fills the window
bookmarkButton

Create a button for bookmarking/sharing
plotPNG

Run a plotting function and save the output as a PNG
downloadButton

Create a download button or link
fillRow

Flex Box-based row/column layouts
icon

Create an icon
installExprFunction

Install an expression as a function
renderDataTable

Table output with the JavaScript library DataTables
reactiveUI

UI output (deprecated)
reactiveTimer

Timer
renderImage

Image file output
safeError

Declare an error safe for the user to see
selectInput

Create a select list input control
fixedPage

Create a page with a fixed layout
runExample

Run Shiny Example Applications
shinyUI

Create a Shiny UI handler
snapshotPreprocessOutput

Add a function for preprocessing an output before taking a test snapshot
showBookmarkUrlModal

Display a modal dialog for bookmarking
insertTab

Dynamically insert/remove a tabPanel
inputPanel

Input panel
knit_print.html

Knitr S3 methods
navlistPanel

Create a navigation list panel
mainPanel

Create a main panel
include

Include Content From a File
nearPoints

Find rows of data that are near a click/hover/double-click
modalDialog

Create a modal dialog UI
navbarPage

Create a page with a top level navigation bar
htmlOutput

Create an HTML output element
is.reactivevalues

Checks whether an object is a reactivevalues object
invalidateLater

Scheduled Invalidation
shiny-options

Global options for Shiny
reactivePoll

Reactive polling
splitLayout

Split layout
shiny-package

Web Application Framework for R
memoryCache

Create a memory cache object
reactivePrint

Print output (deprecated)
sidebarPanel

Create a sidebar panel
htmlTemplate

Process an HTML template
singleton

Include content only once
updateQueryString

Update URL in browser's location bar
updateRadioButtons

Change the value of a radio input on the client
observeEvent

Event handler
onBookmark

Add callbacks for Shiny session bookmarking events
textAreaInput

Create a textarea input control
markRenderFunction

Mark a function as a render function
maskReactiveContext

Evaluate an expression without a reactive context
reactiveTable

Table output (deprecated)
varSelectInput

Select variables from a data frame
textInput

Create a text input control
withProgress

Reporting progress (functional API)
verbatimTextOutput

Create a verbatim text output element
modalButton

Create a button for a modal dialog
reactiveText

Text output (deprecated)
updateActionButton

Change the label or icon of an action button on the client
updateCheckboxGroupInput

Change the value of a checkbox group input on the client
validate

Validate input values and other conditions
outputOptions

Set options for an output object.
withTags

Evaluate an expression using tags
onFlush

Add callbacks for Shiny session events
onStop

Run code after an application or session ends
radioButtons

Create radio buttons
validateCssUnit

Validate proper CSS formatting of a unit
pageWithSidebar

Create a page with a sidebar
removeUI

Remove UI objects
showModal

Show or remove a modal dialog
reactive

Create a reactive expression
reactiveFileReader

Reactive file reader
reactivePlot

Plot output (deprecated)
showNotification

Show or remove a notification
sizeGrowthRatio

Create a sizing function that grows at a given ratio
renderCachedPlot

Plot output with cached images
renderTable

Table Output
reactiveValuesToList

Convert a reactivevalues object to a list
registerInputHandler

Register an Input Handler
renderText

Text Output
serverInfo

Collect information about the Shiny Server environment
sliderInput

Slider Input Widget
submitButton

Create a submit button
reactlog

Reactive Log Visualizer
renderPlot

Plot Output
removeInputHandler

Deregister an Input Handler
req

Check for required values
renderPrint

Printable Output
runGadget

Run a gadget
runUrl

Run a Shiny application from a URL
getShinyOption

Get or set Shiny options
restoreInput

Restore an input value
shinyServer

Define Server Functionality
setBookmarkExclude

Exclude inputs from bookmarking
suppressDependencies

Suppress web dependencies
setSerializer

Add a function for serializing an input before bookmarking application state
shinyApp

Create a Shiny app object
showTab

Dynamically hide/show a tabPanel
session

Session object
updateDateRangeInput

Change the start and end values of a date range input on the client
tabPanel

Create a tab panel
shinyDeprecated

Print message for deprecated functions in Shiny
updateTabsetPanel

Change the selected tab on the client
updateNumericInput

Change the value of a number input on the client
tableOutput

Create a table output element
textOutput

Create a text output element
updateTextAreaInput

Change the value of a textarea input on the client
titlePanel

Create a panel containing an application title.
sidebarLayout

Layout a sidebar and main area
stacktrace

Stack trace manipulation functions
stopApp

Stop the currently running Shiny app
updateTextInput

Change the value of a text input on the client
urlModal

Generate a modal dialog that displays a URL
wellPanel

Create a well panel
snapshotExclude

Mark an output to be excluded from test snapshots
withMathJax

Load the MathJax library and typeset math expressions
snapshotPreprocessInput

Add a function for preprocessing an input before taking a test snapshot
tabsetPanel

Create a tabset panel
tag

HTML Tag Object
updateCheckboxInput

Change the value of a checkbox input on the client
updateSelectInput

Change the value of a select input on the client
updateDateInput

Change the value of a date input on the client
updateSliderInput

Update Slider Input Widget
verticalLayout

Lay out UI elements vertically
viewer

Viewer options