shiny v1.1.0

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.

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

Functions in shiny

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

Include our badge in your README

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