shiny v1.0.1

0

Monthly downloads

0th

Percentile

by Winston Chang

Web Application Framework for R

Makes it incredibly easy to build interactive web applications with R. Automatic "reactive" binding between inputs and outputs and extensive pre-built widgets make it possible to build beautiful, responsive, and powerful applications with minimal effort.

Readme

Shiny

Travis: Travis Build Status

AppVeyor: AppVeyor Build Status

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

Functions in shiny

Name Description
absolutePanel Panel with absolute positioning
brushedPoints Find rows of data that are selected by a brush
conditionalPanel Conditional Panel
builder HTML Builder Functions
column Create a column within a UI definition
callModule Invoke a Shiny module
clickOpts Create an object representing click options
brushOpts Create an object representing brushing options
checkboxGroupInput Checkbox Group Input Control
checkboxInput Checkbox Input Control
createWebDependency Create a web dependency
domains Reactive domains
downloadButton Create a download button or link
dblclickOpts Create an object representing double-click options
downloadHandler File Downloads
dateRangeInput Create date range input
exprToFunction Convert an expression to a function
debounce Slow down a reactive expression with debounce/throttle
enableBookmarking Enable bookmarking for a Shiny application
dateInput Create date input
exportTestValues Register expressions for export in test mode
fileInput File Upload Control
headerPanel Create a header panel
getQueryString Get the query string / hash component from the URL
flowLayout Flow layout
fillPage Create a page that fills the window
helpText Create a help text element
fluidPage Create a page with fluid layout
fixedPage Create a page with a fixed layout
fillRow Flex Box-based row/column layouts
freezeReactiveVal Freeze a reactive value
hoverOpts Create an object representing hover options
inputPanel Input panel
include Include Content From a File
htmlTemplate Process an HTML template
installExprFunction Install an expression as a function
htmlOutput Create an HTML output element
is.reactivevalues Checks whether an object is a reactivevalues object
insertUI Insert UI objects
invalidateLater Scheduled Invalidation
icon Create an icon
makeReactiveBinding Make a reactive variable
markRenderFunction Mark a function as a render function
mainPanel Create a main panel
modalButton Create a button for a modal dialog
knitr_methods Knitr S3 methods
knit_print.html Knitr S3 methods
maskReactiveContext Evaluate an expression without a reactive context
isolate Create a non-reactive scope for an expression
markOutputAttrs Mark a render function with attributes that will be used by the output
observe Create a reactive observer
pageWithSidebar Create a page with a sidebar
modalDialog Create a modal dialog UI
outputOptions Set options for an output object.
observeEvent Event handler
navlistPanel Create a navigation list panel
onBookmark Add callbacks for Shiny session bookmarking events
navbarPage Create a page with a top level navigation bar
onFlush Add callbacks for Shiny session events
nearPoints Find rows of data that are near a click/hover/double-click
reactiveFileReader Reactive file reader
plotOutput Create an plot or image output element
passwordInput Create a password input control
reactive Create a reactive expression
numericInput Create a numeric input control
reactivePrint Print output (deprecated)
plotPNG Run a plotting function and save the output as a PNG
radioButtons Create radio buttons
parseQueryString Parse a GET query string from a URL
reactivePoll Reactive polling
reactiveText Text output (deprecated)
reactivePlot Plot output (deprecated)
reactiveTimer Timer
reactiveVal Create a (single) reactive value
reactiveValuesToList Convert a reactivevalues object to a list
reactiveTable Table output (deprecated)
removeInputHandler Deregister an Input Handler
reactiveUI UI output (deprecated)
removeUI Remove UI objects
reactiveValues Create an object for storing reactive values
renderText Text Output
registerInputHandler Register an Input Handler
renderUI UI Output
renderDataTable Table output with the JavaScript library DataTables
repeatable Make a random number generator repeatable
renderPlot Plot Output
renderImage Image file output
req Check for required values
renderTable Table Output
renderPrint Printable Output
restoreInput Restore an input value
runUrl Run a Shiny application from a URL
runGadget Run a gadget
shiny-options Global options for Shiny
runApp Run Shiny Application
serverInfo Collect information about the Shiny Server environment
runExample Run Shiny Example Applications
selectInput Create a select list input control
setBookmarkExclude Exclude inputs from bookmarking
session Session object
safeError Declare an error safe for the user to see
showNotification Show or remove a notification
getShinyOption Get or set Shiny options
shinyApp Create a Shiny app object
shinyServer Define Server Functionality
shinyUI Create a Shiny UI handler
showBookmarkUrlModal Display a modal dialog for bookmarking
shiny-package Web Application Framework for R
shinyDeprecated Print message for deprecated functions in Shiny
showReactLog Reactive Log Visualizer
showModal Show or remove a modal dialog
sidebarPanel Create a sidebar panel
stacktrace Stack trace manipulation functions
snapshotExclude Mark an output to be excluded from test snapshots
sidebarLayout Layout a sidebar and main area
stopApp Stop the currently running Shiny app
singleton Include content only once
splitLayout Split layout
submitButton Create a submit button
suppressDependencies Suppress web dependencies
textInput Create a text input control
tabsetPanel Create a tabset panel
tableOutput Create a table output element
updateCheckboxGroupInput Change the value of a checkbox group input on the client
textAreaInput Create a textarea input control
sliderInput Slider Input Widget
tabPanel Create a tab panel
textOutput Create a text output element
updateActionButton Change the label or icon of an action button on the client
titlePanel Create a panel containing an application title.
tag HTML Tag Object
updateDateRangeInput Change the start and end values of a date range input on the client
updateRadioButtons Change the value of a radio input on the client
updateTextAreaInput Change the value of a textarea input on the client
updateSliderInput Change the value of a slider input on the client
updateCheckboxInput Change the value of a checkbox input on the client
updateSelectInput Change the value of a select input on the client
updateQueryString Update URL in browser's location bar
updateDateInput Change the value of a date input on the client
updateNumericInput Change the value of a number input on the client
updateTabsetPanel Change the selected tab on the client
viewer Viewer options
withMathJax Load the MathJax library and typeset math expressions
validate Validate input values and other conditions
verticalLayout Lay out UI elements vertically
wellPanel Create a well panel
validateCssUnit Validate proper CSS formatting of a unit
verbatimTextOutput Create a verbatim text output element
withProgress Reporting progress (functional API)
updateTextInput Change the value of a text input on the client
urlModal Generate a modal dialog that displays a URL
NS Namespaced IDs for inputs/outputs
withTags Evaluate an expression using
actionButton Action button/link
addResourcePath Resource Publishing
Progress Reporting progress (object-oriented API)
bootstrapPage Create a Bootstrap page
HTML Mark Characters as HTML
bootstrapLib Bootstrap libraries
applyInputHandlers Apply input handlers to raw input values
bookmarkButton Create a button for bookmarking/sharing
No Results!

Last month downloads

Details

Type Package
License GPL-3 | file LICENSE
URL http://shiny.rstudio.com
BugReports https://github.com/rstudio/shiny/issues
Collate 'app.R' 'bookmark-state-local.R' 'stack.R' 'bookmark-state.R' 'bootstrap-layout.R' 'conditions.R' 'map.R' 'globals.R' 'utils.R' 'bootstrap.R' 'cache.R' 'diagnose.R' 'fileupload.R' 'graph.R' 'reactives.R' 'reactive-domains.R' 'history.R' 'hooks.R' 'html-deps.R' 'htmltools.R' 'image-interact-opts.R' 'image-interact.R' 'imageutils.R' 'input-action.R' 'input-checkbox.R' 'input-checkboxgroup.R' 'input-date.R' 'input-daterange.R' 'input-file.R' 'input-numeric.R' 'input-password.R' 'input-radiobuttons.R' 'input-select.R' 'input-slider.R' 'input-submit.R' 'input-text.R' 'input-textarea.R' 'input-utils.R' 'insert-ui.R' 'jqueryui.R' 'middleware-shiny.R' 'middleware.R' 'modal.R' 'modules.R' 'notifications.R' 'priorityqueue.R' 'progress.R' 'react.R' 'render-plot.R' 'render-table.R' 'run-url.R' 'serializers.R' 'server-input-handlers.R' 'server.R' 'shiny-options.R' 'shiny.R' 'shinyui.R' 'shinywrappers.R' 'showcase.R' 'tar.R' 'test-export.R' 'timer.R' 'update-input.R'
RoxygenNote 6.0.1
NeedsCompilation no
Packaged 2017-03-31 21:07:22 UTC; winston
Repository CRAN
Date/Publication 2017-04-01 17:25:17 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/shiny)](http://www.rdocumentation.org/packages/shiny)