shiny v1.3.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 as a whole is licensed under the GPLv3. See the LICENSE file for more details.

Functions in shiny

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

Include our badge in your README

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