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.

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.
  • Pre-built 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.

We hope you enjoy using Shiny. If you have general questions about using Shiny, please use the Shiny mailing list. For bug reports, please use the issue tracker.

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

554,825

Version

1.0.0

License

GPL-3 | file LICENSE

Maintainer

Winston Chang

Last Published

January 12th, 2017

Functions in shiny (1.0.0)

suppressDependencies

Suppress web dependencies
tableOutput

Create a table output element
renderImage

Image file output
updateSelectInput

Change the value of a select input on the client
updateRadioButtons

Change the value of a radio input on the client
updateQueryString

Update URL in browser's location bar
updateNumericInput

Change the value of a number input on the client
withProgress

Reporting progress (functional API)
callModule

Invoke a Shiny module
withTags

Evaluate an expression using tags
registerInputHandler

Register an Input Handler
isolate

Create a non-reactive scope for an expression
radioButtons

Create radio buttons
runExample

Run Shiny Example Applications
removeInputHandler

Deregister an Input Handler
dateInput

Create date input
brushOpts

Create an object representing brushing options
runGadget

Run a gadget
splitLayout

Split layout
runUrl

Run a Shiny application from a URL
safeError

Declare an error safe for the user to see
stacktrace

Stack trace manipulation functions
selectInput

Create a select list input control
updateDateInput

Change the value of a date input on the client
serverInfo

Collect information about the Shiny Server environment
sidebarLayout

Layout a sidebar and main area
sidebarPanel

Create a sidebar panel
validateCssUnit

Validate proper CSS formatting of a unit
verbatimTextOutput

Create a verbatim text output element
createWebDependency

Create a web dependency
domains

Reactive domains
insertUI

Insert UI objects
navlistPanel

Create a navigation list panel
builder

HTML Builder Functions
helpText

Create a help text element
inputPanel

Input panel
headerPanel

Create a header panel
debounce

Slow down a reactive expression with debounce/throttle
repeatable

Make a random number generator repeatable
navbarPage

Create a page with a top level navigation bar
onBookmark

Add callbacks for Shiny session bookmarking events
req

Check for required values
reactivePoll

Reactive polling
showBookmarkUrlModal

Display a modal dialog for bookmarking
showModal

Show or remove a modal dialog
tag

HTML Tag Object
updateCheckboxGroupInput

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

Event handler
conditionalPanel

Conditional Panel
updateDateRangeInput

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

Change the selected tab on the client
updateSliderInput

Change the value of a slider input on the client
verticalLayout

Lay out UI elements vertically
viewer

Viewer options
textAreaInput

Create a textarea input control
reactivePrint

Print output (deprecated)
updateCheckboxInput

Change the value of a checkbox input on the client
outputOptions

Set options for an output object.
fixedPage

Create a page with a fixed layout
absolutePanel

Panel with absolute positioning
actionButton

Action button/link
flowLayout

Flow layout
include

Include Content From a File
mainPanel

Create a main panel
onFlush

Add callbacks for Shiny session events
makeReactiveBinding

Make a reactive variable
bootstrapLib

Bootstrap libraries
column

Create a column within a UI definition
brushedPoints

Find rows of data that are selected by a brush
enableBookmarking

Enable bookmarking for a Shiny application
bootstrapPage

Create a Bootstrap page
dateRangeInput

Create date range input
dblclickOpts

Create an object representing double-click options
bookmarkButton

Create a button for bookmarking/sharing
fillPage

Create a page that fills the window
modalDialog

Create a modal dialog UI
freezeReactiveValue

Freeze a reactive value
Progress

Reporting progress (object-oriented API)
invalidateLater

Scheduled Invalidation
knit_print.html

Knitr S3 methods
NS

Namespaced IDs for inputs/outputs
nearPoints

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

Convert a reactivevalues object to a list
knitr_methods

Knitr S3 methods
plotOutput

Create an plot or image output element
reactiveValues

Create an object for storing reactive values
runApp

Run Shiny Application
passwordInput

Create a password input control
exportTestValues

Register expressions for export in test mode
setBookmarkExclude

Exclude inputs from bookmarking
restoreInput

Restore an input value
shiny-options

Global options for Shiny
shinyServer

Define Server Functionality
tabPanel

Create a tab panel
shinyUI

Create a Shiny UI handler
tabsetPanel

Create a tabset panel
titlePanel

Create a panel containing an application title.
withMathJax

Load the MathJax library and typeset math expressions
markRenderFunction

Mark a function as a render function
checkboxInput

Checkbox Input Control
clickOpts

Create an object representing click options
downloadHandler

File Downloads
htmlTemplate

Process an HTML template
downloadButton

Create a download button or link
reactiveText

Text output (deprecated)
htmlOutput

Create an HTML output element
maskReactiveContext

Evaluate an expression without a reactive context
icon

Create an icon
removeUI

Remove UI objects
renderDataTable

Table output with the JavaScript library DataTables
reactiveFileReader

Reactive file reader
reactivePlot

Plot output (deprecated)
updateActionButton

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

Validate input values and other conditions
urlModal

Generate a modal dialog that displays a URL
wellPanel

Create a well panel
installExprFunction

Install an expression as a function
plotPNG

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

Show or remove a notification
renderPrint

Printable Output
fillRow

Flex Box-based row/column layouts
stopApp

Stop the currently running Shiny app
fluidPage

Create a page with fluid layout
modalButton

Create a button for a modal dialog
reactiveTimer

Timer
observe

Create a reactive observer
shinyApp

Create a Shiny app object
showReactLog

Reactive Log Visualizer
shiny-package

Web Application Framework for R
reactiveTable

Table output (deprecated)
parseQueryString

Parse a GET query string from a URL
renderPlot

Plot Output
renderUI

UI Output
renderText

Text Output
shinyDeprecated

Print message for deprecated functions in Shiny
singleton

Include content only once
pageWithSidebar

Create a page with a sidebar
sliderInput

Slider Input Widget
getShinyOption

Get or set Shiny options
numericInput

Create a numeric input control
updateTextAreaInput

Change the value of a textarea input on the client
renderTable

Table Output
reactiveUI

UI output (deprecated)
submitButton

Create a submit button
textOutput

Create a text output element
textInput

Create a text input control
updateTextInput

Change the value of a text input on the client
HTML

Mark Characters as HTML
is.reactivevalues

Checks whether an object is a reactivevalues object
fileInput

File Upload Control
hoverOpts

Create an object representing hover options
applyInputHandlers

Apply input handlers to raw input values
reactive

Create a reactive expression
addResourcePath

Resource Publishing
checkboxGroupInput

Checkbox Group Input Control
exprToFunction

Convert an expression to a function