Function reference version 1.0.0

UI Layout

Functions for laying out the user interface for your application.

absolutePanel (fixedPanel)

Panel with absolute positioning

bootstrapPage (basicPage)

Create a Bootstrap page

column

Create a column within a UI definition

conditionalPanel

Conditional Panel

fillPage

Create a page that fills the window

fillRow (fillCol)

Flex Box-based row/column layouts

fixedPage (fixedRow)

Create a page with a fixed layout

fluidPage (fluidRow)

Create a page with fluid layout

headerPanel

Create a header panel

helpText

Create a help text element

icon

Create an icon

mainPanel

Create a main panel

navbarPage (navbarMenu)

Create a page with a top level navigation bar

navlistPanel

Create a navigation list panel

pageWithSidebar

Create a page with a sidebar

sidebarLayout

Layout a sidebar and main area

sidebarPanel

Create a sidebar panel

tabPanel

Create a tab panel

tabsetPanel

Create a tabset panel

titlePanel

Create a panel containing an application title.

inputPanel

Input panel

flowLayout

Flow layout

splitLayout

Split layout

verticalLayout

Lay out UI elements vertically

wellPanel

Create a well panel

withMathJax

Load the MathJax library and typeset math expressions

UI Inputs

Functions for creating user interface elements that prompt the user for input values or interaction.

actionButton (actionLink)

Action button/link

checkboxGroupInput

Checkbox Group Input Control

checkboxInput

Checkbox Input Control

dateInput

Create date input

dateRangeInput

Create date range input

fileInput

File Upload Control

numericInput

Create a numeric input control

radioButtons

Create radio buttons

selectInput (selectizeInput)

Create a select list input control

sliderInput (animationOptions)

Slider Input Widget

submitButton

Create a submit button

textInput

Create a text input control

textAreaInput

Create a textarea input control

passwordInput

Create a password input control

modalButton

Create a button for a modal dialog

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

updateCheckboxInput

Change the value of a checkbox input on the client

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

updateRadioButtons

Change the value of a radio input on the client

updateSelectInput (updateSelectizeInput)

Change the value of a select input on the client

updateSliderInput

Change the value of a slider input on the client

updateTabsetPanel (updateNavbarPage, updateNavlistPanel)

Change the selected tab on the client

updateTextInput

Change the value of a text input on the client

updateTextAreaInput

Change the value of a textarea input on the client

updateQueryString

Update URL in browser's location bar

UI Outputs

Functions for creating user interface elements that, in conjunction with rendering functions, display different kinds of output from your application.

htmlOutput (uiOutput)

Create an HTML output element

plotOutput (imageOutput)

Create an plot or image output element

outputOptions

Set options for an output object.

tableOutput (dataTableOutput)

Create a table output element

textOutput

Create a text output element

verbatimTextOutput

Create a verbatim text output element

downloadButton (downloadLink)

Create a download button or link

Progress

Reporting progress (object-oriented API)

withProgress (incProgress, setProgress)

Reporting progress (functional API)

modalDialog

Create a modal dialog UI

urlModal

Generate a modal dialog that displays a URL

showModal (removeModal)

Show or remove a modal dialog

showNotification (removeNotification)

Show or remove a notification

Interface builder functions

A sub-library for writing HTML using R functions. These functions form the foundation on which the higher level user interface functions are built, and can also be used in your Shiny UI to provide custom HTML, CSS, and JavaScript.

builder (a, br, code, div, em, h1, h2, h3, h4, h5, h6, hr, img, p, pre, span, strong, tags)

HTML Builder Functions

HTML

Mark Characters as HTML

include (includeCSS, includeHTML, includeMarkdown, includeScript, includeText)

Include Content From a File

singleton (is.singleton)

Include content only once

tag (tagAppendAttributes, tagAppendChild, tagAppendChildren, tagList, tagSetChildren)

HTML Tag Object

validateCssUnit

Validate proper CSS formatting of a unit

withTags

Evaluate an expression using tags

htmlTemplate

Process an HTML template

bootstrapLib

Bootstrap libraries

suppressDependencies

Suppress web dependencies

insertUI

Insert UI objects

removeUI

Remove UI objects

Rendering functions

Functions that you use in your application's server side code, assigning them to outputs that appear in your user interface.

renderPlot

Plot Output

renderText

Text Output

renderPrint

Printable Output

renderDataTable

Table output with the JavaScript library DataTables

renderImage

Image file output

renderTable

Table Output

renderUI

UI Output

downloadHandler

File Downloads

reactivePlot

Plot output (deprecated)

reactivePrint

Print output (deprecated)

reactiveTable

Table output (deprecated)

reactiveText

Text output (deprecated)

reactiveUI

UI output (deprecated)

Reactive programming

A sub-library that provides reactive programming facilities for R.

reactive (is.reactive)

Create a reactive expression

observe

Create a reactive observer

observeEvent (eventReactive)

Event handler

reactiveValues

Create an object for storing reactive values

reactiveValuesToList

Convert a reactivevalues object to a list

is.reactivevalues

Checks whether an object is a reactivevalues object

isolate

Create a non-reactive scope for an expression

invalidateLater

Scheduled Invalidation

debounce (throttle)

Slow down a reactive expression with debounce/throttle

showReactLog

Reactive Log Visualizer

makeReactiveBinding

Make a reactive variable

reactiveFileReader

Reactive file reader

reactivePoll

Reactive polling

reactiveTimer

Timer

domains (getDefaultReactiveDomain, onReactiveDomainEnded, withReactiveDomain)

Reactive domains

freezeReactiveValue

Freeze a reactive value

Boilerplate

Functions that are required boilerplate in ui.R and server.R.

shinyUI

Create a Shiny UI handler

shinyServer

Define Server Functionality

Running

Functions that are used to run or stop Shiny applications.

runApp

Run Shiny Application

runGadget

Run a gadget

runExample

Run Shiny Example Applications

runGadget

Run a gadget

runUrl (runGist, runGitHub)

Run a Shiny application from a URL

stopApp

Stop the currently running Shiny app

viewer (browserViewer, dialogViewer, paneViewer)

Viewer options

Bookmarking state

Functions that are used for bookmarking and restoring state.

bookmarkButton

Create a button for bookmarking/sharing

enableBookmarking

Enable bookmarking for a Shiny application

setBookmarkExclude

Exclude inputs from bookmarking

showBookmarkUrlModal

Display a modal dialog for bookmarking

onBookmark (onBookmarked, onRestore, onRestored)

Add callbacks for Shiny session bookmarking events

Extending Shiny

Functions that are intended to be called by third-party packages that extend Shiny.

createWebDependency

Create a web dependency

addResourcePath

Resource Publishing

registerInputHandler

Register an Input Handler

removeInputHandler

Deregister an Input Handler

markRenderFunction

Mark a function as a render function

Utility functions

Miscellaneous utilities that may be useful to advanced users or when extending Shiny.

req (isTruthy)

Check for required values

validate (need)

Validate input values and other conditions

session

Session object

safeError

Declare an error safe for the user to see

onFlush (onFlushed, onSessionEnded)

Add callbacks for Shiny session events

restoreInput

Restore an input value

applyInputHandlers

Apply input handlers to raw input values

exprToFunction

Convert an expression to a function

installExprFunction

Install an expression as a function

parseQueryString

Parse a GET query string from a URL

plotPNG

Run a plotting function and save the output as a PNG

exportTestValues

Register expressions for export in test mode

repeatable

Make a random number generator repeatable

shinyDeprecated

Print message for deprecated functions in Shiny

serverInfo

Collect information about the Shiny Server environment

shiny-options

Global options for Shiny

Plot interaction

Functions related to interactive plots

brushedPoints

Find rows of data that are selected by a brush

brushOpts

Create an object representing brushing options

clickOpts

Create an object representing click options

dblclickOpts

Create an object representing double-click options

hoverOpts

Create an object representing hover options

nearPoints

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

Modules

Functions for modularizing Shiny apps

NS (ns.sep)

Namespaced IDs for inputs/outputs

callModule

Invoke a Shiny module

Embedding

Functions that are intended for third-party packages that embed Shiny applications.

shinyApp (as.shiny.appobj, as.shiny.appobj.character, as.shiny.appobj.list, as.shiny.appobj.shiny.appobj, as.tags.shiny.appobj, is.shiny.appobj, print.shiny.appobj, shinyAppDir, shinyAppFile)

Create a Shiny app object

maskReactiveContext

Evaluate an expression without a reactive context

Other

getShinyOption (shinyOptions)

Get or set Shiny options

knit_print.html (knit_print.shiny.tag, knit_print.shiny.tag.list)

Knitr S3 methods

knitr_methods (knit_print.reactive, knit_print.shiny.appobj, knit_print.shiny.render.function)

Knitr S3 methods

shiny-package (shiny)

Web Application Framework for R