Learn R Programming
⚠️There's a newer version (1.9.1) 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 is licensed under the GPLv3. See these files in the inst directory for additional details:

  • COPYING - shiny package license (GPLv3)
  • NOTICE - Copyright notices for additional included software

Copy Link

Version

Install

install.packages('shiny')

Monthly Downloads

543,282

Version

1.2.0

License

GPL-3 | file LICENSE

Maintainer

Winston Chang

Last Published

November 2nd, 2018

Functions in shiny (1.2.0)

HTML

Mark Characters as HTML
Progress

Reporting progress (object-oriented API)
brushedPoints

Find rows of data that are selected by a brush
absolutePanel

Panel with absolute positioning
domains

Reactive domains
conditionalPanel

Conditional Panel
createRenderFunction

Implement render functions
downloadButton

Create a download button or link
fillRow

Flex Box-based row/column layouts
fixedPage

Create a page with a fixed layout
downloadHandler

File Downloads
enableBookmarking

Enable bookmarking for a Shiny application
getQueryString

Get the query string / hash component from the URL
applyInputHandlers

Apply input handlers to raw input values
bookmarkButton

Create a button for bookmarking/sharing
headerPanel

Create a header panel
builder

HTML Builder Functions
callModule

Invoke a Shiny module
inputPanel

Input panel
knit_print.html

Knitr S3 methods
mainPanel

Create a main panel
navlistPanel

Create a navigation list panel
nearPoints

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

Event handler
insertTab

Dynamically insert/remove a tabPanel
onBookmark

Add callbacks for Shiny session bookmarking events
debounce

Slow down a reactive expression with debounce/throttle
key_missing

A Key Missing object
knitr_methods

Knitr S3 methods
diskCache

Create a disk cache object
renderDataTable

Table output with the JavaScript library DataTables
renderCachedPlot

Plot output with cached images
renderImage

Image file output
renderPlot

Plot Output
runExample

Run Shiny Example Applications
markRenderFunction

Mark a function as a render function
maskReactiveContext

Evaluate an expression without a reactive context
flowLayout

Flow layout
fluidPage

Create a page with fluid layout
runGadget

Run a gadget
bootstrapLib

Bootstrap libraries
bootstrapPage

Create a Bootstrap page
outputOptions

Set options for an output object.
checkboxGroupInput

Checkbox Group Input Control
pageWithSidebar

Create a page with a sidebar
reactiveTable

Table output (deprecated)
shiny-package

Web Application Framework for R
checkboxInput

Checkbox Input Control
createWebDependency

Create a web dependency
shinyApp

Create a Shiny app object
reactiveText

Text output (deprecated)
icon

Create an icon
dateInput

Create date input
removeInputHandler

Deregister an Input Handler
removeUI

Remove UI objects
renderText

Text Output
renderUI

UI Output
stacktrace

Stack trace manipulation functions
fileInput

File Upload Control
fillPage

Create a page that fills the window
hoverOpts

Create an object representing hover options
helpText

Create a help text element
setSerializer

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

Include Content From a File
invalidateLater

Scheduled Invalidation
is.reactivevalues

Checks whether an object is a reactivevalues object
shiny-options

Global options for Shiny
varSelectInput

Select variables from a data frame
verbatimTextOutput

Create a verbatim text output element
makeReactiveBinding

Make a reactive variable
stopApp

Stop the currently running Shiny app
showBookmarkUrlModal

Display a modal dialog for bookmarking
showModal

Show or remove a modal dialog
sizeGrowthRatio

Create a sizing function that grows at a given ratio
sliderInput

Slider Input Widget
exportTestValues

Register expressions for export in test mode
markOutputAttrs

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

Action button/link
tabPanel

Create a tab panel
exprToFunction

Convert an expression to a function
addResourcePath

Resource Publishing
clickOpts

Create an object representing click options
column

Create a column within a UI definition
dateRangeInput

Create date range input
numericInput

Create a numeric input control
insertUI

Insert UI objects
htmlOutput

Create an HTML output element
tableOutput

Create a table output element
observe

Create a reactive observer
textOutput

Create a text output element
reactiveFileReader

Reactive file reader
installExprFunction

Install an expression as a function
dblclickOpts

Create an object representing double-click options
titlePanel

Create a panel containing an application title.
htmlTemplate

Process an HTML template
passwordInput

Create a password input control
parseQueryString

Parse a GET query string from a URL
reactivePlot

Plot output (deprecated)
updateTextInput

Change the value of a text input on the client
reactiveTimer

Timer
radioButtons

Create radio buttons
reactive

Create a reactive expression
urlModal

Generate a modal dialog that displays a URL
freezeReactiveVal

Freeze a reactive value
reactiveUI

UI output (deprecated)
withProgress

Reporting progress (functional API)
renderPrint

Printable Output
withTags

Evaluate an expression using tags
getCurrentOutputInfo

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

Create an object for storing reactive values
reactiveVal

Create a (single) reactive value
renderTable

Table Output
restoreInput

Restore an input value
modalDialog

Create a modal dialog UI
navbarPage

Create a page with a top level navigation bar
runApp

Run Shiny Application
runUrl

Run a Shiny application from a URL
safeError

Declare an error safe for the user to see
shinyServer

Define Server Functionality
reactivePoll

Reactive polling
shinyUI

Create a Shiny UI handler
snapshotPreprocessOutput

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

Split layout
tabsetPanel

Create a tabset panel
showNotification

Show or remove a notification
tag

HTML Tag Object
showReactLog

Reactive Log Visualizer
reactivePrint

Print output (deprecated)
updateActionButton

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

Check whether a Shiny application is running
showTab

Dynamically hide/show a tabPanel
wellPanel

Create a well panel
withMathJax

Load the MathJax library and typeset math expressions
updateCheckboxGroupInput

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

Session object
isolate

Create a non-reactive scope for an expression
memoryCache

Create a memory cache object
sidebarLayout

Layout a sidebar and main area
modalButton

Create a button for a modal dialog
onFlush

Add callbacks for Shiny session events
onStop

Run code after an application or session ends
setBookmarkExclude

Exclude inputs from bookmarking
plotOutput

Create an plot or image output element
plotPNG

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

Convert a reactivevalues object to a list
updateCheckboxInput

Change the value of a checkbox input on the client
updateDateInput

Change the value of a date input on the client
snapshotExclude

Mark an output to be excluded from test snapshots
validate

Validate input values and other conditions
snapshotPreprocessInput

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

Create a submit button
registerInputHandler

Register an Input Handler
suppressDependencies

Suppress web dependencies
repeatable

Make a random number generator repeatable
req

Check for required values
validateCssUnit

Validate proper CSS formatting of a unit
verticalLayout

Lay out UI elements vertically
updateDateRangeInput

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

Create a select list input control
updateNumericInput

Change the value of a number input on the client
serverInfo

Collect information about the Shiny Server environment
updateSelectInput

Change the value of a select input on the client
shinyDeprecated

Print message for deprecated functions in Shiny
viewer

Viewer options
updateSliderInput

Update Slider Input Widget
getShinyOption

Get or set Shiny options
sidebarPanel

Create a sidebar panel
singleton

Include content only once
textInput

Create a text input control
textAreaInput

Create a textarea input control
updateQueryString

Update URL in browser's location bar
updateRadioButtons

Change the value of a radio input on the client
updateTabsetPanel

Change the selected tab on the client
updateTextAreaInput

Change the value of a textarea input on the client
NS

Namespaced IDs for inputs/outputs
brushOpts

Create an object representing brushing options