shiny v1.0.5

0

Monthly downloads

0th

Percentile

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 prebuilt 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.
  • 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.

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

Include our badge in your README

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