From e7bdceedcbd6f4f86389da05f2a770da55eed7b6 Mon Sep 17 00:00:00 2001 From: cpsievert Date: Tue, 14 Jun 2022 14:23:43 +0000 Subject: [PATCH] Built site for shiny: 1.7.1.9003@8a5da25 --- 404.html | 2 +- CONTRIBUTING.html | 2 +- LICENSE-text.html | 2 +- TODO-promises.html | 2 +- apple-touch-icon-120x120.png | Bin 10047 -> 10047 bytes apple-touch-icon-152x152.png | Bin 13274 -> 13274 bytes apple-touch-icon-180x180.png | Bin 15862 -> 15862 bytes apple-touch-icon-60x60.png | Bin 4404 -> 4404 bytes apple-touch-icon-76x76.png | Bin 5849 -> 5849 bytes apple-touch-icon.png | Bin 15862 -> 15862 bytes authors.html | 2 +- favicon-16x16.png | Bin 1135 -> 1135 bytes favicon-32x32.png | Bin 2159 -> 2159 bytes index.html | 2 +- news/index.html | 21 ++++---- pkgdown.yml | 4 +- reference/MockShinySession.html | 2 +- reference/NS.html | 9 +++- reference/Progress.html | 2 +- reference/absolutePanel.html | 25 ++++++++- reference/actionButton.html | 11 +++- reference/applyInputHandlers.html | 5 +- reference/bindCache.html | 34 +++++++++--- reference/bindEvent.html | 13 ++++- reference/bookmarkButton.html | 11 +++- reference/bootstrapLib.html | 3 +- reference/bootstrapPage.html | 13 ++++- reference/brushOpts.html | 19 ++++++- reference/brushedPoints.html | 27 ++++++++-- reference/callModule.html | 13 ++++- reference/checkboxGroupInput.html | 19 ++++++- reference/checkboxInput.html | 13 ++++- reference/clickOpts.html | 11 +++- reference/column.html | 11 +++- reference/conditionalPanel.html | 7 ++- reference/createRenderFunction.html | 35 +++++++++++- reference/createWebDependency.html | 9 +++- reference/dateInput.html | 27 +++++++++- reference/dateRangeInput.html | 27 +++++++++- reference/debounce.html | 9 +++- reference/devmode.html | 25 ++++++++- reference/diskCache.html | 19 ++++++- reference/domains.html | 9 +++- reference/downloadButton.html | 11 +++- reference/downloadHandler.html | 9 +++- reference/enableBookmarking.html | 3 +- reference/exportTestValues.html | 9 +++- reference/exprToFunction.html | 7 ++- reference/fileInput.html | 17 +++++- reference/fillPage.html | 13 ++++- reference/fillRow.html | 7 ++- reference/fixedPage.html | 13 ++++- reference/flowLayout.html | 5 +- reference/fluidPage.html | 13 ++++- reference/freezeReactiveValue.html | 5 +- reference/getCurrentOutputInfo.html | 7 ++- reference/getCurrentTheme.html | 11 ++-- reference/getQueryString.html | 7 ++- reference/headerPanel.html | 11 +++- reference/helpText.html | 7 ++- reference/htmlOutput.html | 13 ++++- reference/httpResponse.html | 9 +++- reference/icon.html | 29 ++++++---- reference/index.html | 2 +- reference/inputPanel.html | 3 +- reference/insertTab.html | 15 +++++- reference/insertUI.html | 13 ++++- reference/invalidateLater.html | 5 +- reference/is.reactivevalues.html | 3 +- reference/isRunning.html | 6 ++- reference/isTruthy.html | 3 +- reference/isolate.html | 3 +- reference/knitr_methods.html | 7 ++- reference/loadSupport.html | 7 ++- reference/makeReactiveBinding.html | 9 +++- reference/markOutputAttrs.html | 7 ++- reference/markRenderFunction.html | 17 +++++- reference/markdown.html | 13 ++++- reference/maskReactiveContext.html | 7 ++- reference/memoryCache.html | 15 +++++- reference/modalDialog.html | 17 +++++- reference/moduleServer.html | 11 +++- reference/navbarPage.html | 69 +++++++++++++++++------- reference/navlistPanel.html | 33 ++++++++---- reference/numericInput.html | 19 ++++++- reference/observe.html | 25 ++++++++- reference/observeEvent.html | 41 +++++++++++++- reference/onBookmark.html | 5 +- reference/onFlush.html | 7 ++- reference/onStop.html | 9 +++- reference/outputOptions.html | 7 ++- reference/pageWithSidebar.html | 11 +++- reference/parseQueryString.html | 5 +- reference/passwordInput.html | 15 +++++- reference/plotOutput.html | 19 ++++++- reference/plotPNG.html | 13 ++++- reference/radioButtons.html | 19 ++++++- reference/reactive.html | 21 ++++++-- reference/reactiveConsole.html | 3 +- reference/reactiveFileReader.html | 15 +++++- reference/reactivePoll.html | 15 ++++-- reference/reactiveTimer.html | 9 +++- reference/reactiveVal.html | 9 +++- reference/reactiveValues.html | 3 +- reference/reactiveValuesToList.html | 5 +- reference/reactlog.html | 3 +- reference/reexports.html | 2 +- reference/registerInputHandler.html | 7 ++- reference/registerThemeDependency.html | 3 +- reference/removeInputHandler.html | 7 ++- reference/renderCachedPlot.html | 19 ++++++- reference/renderDataTable.html | 19 ++++++- reference/renderImage.html | 11 +++- reference/renderPlot.html | 19 ++++++- reference/renderPrint.html | 20 ++++++- reference/renderTable.html | 27 +++++++++- reference/renderUI.html | 9 +++- reference/repeatable.html | 17 +++--- reference/req.html | 23 ++++++-- reference/resourcePaths.html | 5 +- reference/restoreInput.html | 5 +- reference/runApp.html | 17 +++++- reference/runExample.html | 11 +++- reference/runGadget.html | 15 +++++- reference/runTests.html | 13 ++++- reference/runUrl.html | 19 ++++++- reference/safeError.html | 7 ++- reference/selectInput.html | 25 ++++++++- reference/serverInfo.html | 6 ++- reference/session.html | 34 +++++++++++- reference/setBookmarkExclude.html | 5 +- reference/setSerializer.html | 7 ++- reference/shiny-package.html | 2 +- reference/shiny.appobj.html | 5 +- reference/shinyApp.html | 21 +++++++- reference/shinyAppTemplate.html | 26 +++++++-- reference/shinyDeprecated.html | 9 +++- reference/shinyOptions.html | 7 ++- reference/shinyServer.html | 3 +- reference/shinyUI.html | 7 ++- reference/showBookmarkUrlModal.html | 3 +- reference/showModal.html | 5 +- reference/showNotification.html | 19 ++++++- reference/showTab.html | 9 +++- reference/sidebarLayout.html | 13 ++++- reference/sizeGrowthRatio.html | 5 +- reference/sliderInput.html | 39 +++++++++++++- reference/snapshotExclude.html | 3 +- reference/snapshotPreprocessInput.html | 7 ++- reference/snapshotPreprocessOutput.html | 5 +- reference/splitLayout.html | 7 ++- reference/stacktrace.html | 15 +++++- reference/stopApp.html | 3 +- reference/submitButton.html | 11 +++- reference/tabPanel.html | 31 +++++++---- reference/tabsetPanel.html | 35 ++++++++---- reference/testServer.html | 9 +++- reference/textAreaInput.html | 23 +++++++- reference/textInput.html | 15 +++++- reference/textOutput.html | 13 ++++- reference/titlePanel.html | 5 +- reference/updateActionButton.html | 9 +++- reference/updateCheckboxGroupInput.html | 15 +++++- reference/updateCheckboxInput.html | 9 +++- reference/updateDateInput.html | 13 ++++- reference/updateDateRangeInput.html | 15 +++++- reference/updateNumericInput.html | 15 +++++- reference/updateQueryString.html | 7 ++- reference/updateRadioButtons.html | 15 +++++- reference/updateSelectInput.html | 17 +++++- reference/updateSliderInput.html | 17 +++++- reference/updateTabsetPanel.html | 7 ++- reference/updateTextAreaInput.html | 11 +++- reference/updateTextInput.html | 11 +++- reference/urlModal.html | 7 ++- reference/validate.html | 15 +++++- reference/varSelectInput.html | 25 ++++++++- reference/verticalLayout.html | 5 +- reference/viewer.html | 13 ++++- reference/wellPanel.html | 7 ++- reference/withMathJax.html | 3 +- reference/withProgress.html | 27 +++++++++- 182 files changed, 1847 insertions(+), 317 deletions(-) diff --git a/404.html b/404.html index c0cc6bee6..32b5c57dd 100644 --- a/404.html +++ b/404.html @@ -95,7 +95,7 @@ Content not found. Please use links in the navbar.

-

Site built with pkgdown 2.0.3.

+

Site built with pkgdown 2.0.4.

diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index 6b961ba70..c36e93012 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -89,7 +89,7 @@
-

Site built with pkgdown 2.0.3.

+

Site built with pkgdown 2.0.4.

diff --git a/LICENSE-text.html b/LICENSE-text.html index 32651ae79..1fda35108 100644 --- a/LICENSE-text.html +++ b/LICENSE-text.html @@ -1077,7 +1077,7 @@ Public License instead of this License.
-

Site built with pkgdown 2.0.3.

+

Site built with pkgdown 2.0.4.

diff --git a/TODO-promises.html b/TODO-promises.html index cf498dcd6..90e5f74f2 100644 --- a/TODO-promises.html +++ b/TODO-promises.html @@ -155,7 +155,7 @@
-

Site built with pkgdown 2.0.3.

+

Site built with pkgdown 2.0.4.

diff --git a/apple-touch-icon-120x120.png b/apple-touch-icon-120x120.png index bfce0a68bf7848fe871db61d65a39d4b68c1ae20..79e3ee3e5566c27997104e4a5f229aafffca66f2 100644 GIT binary patch delta 69 zcmdn*x8H9<6$c-mn1Y{O#?FmRoN6K_A%-SaMn+b~M%o4jRt5%Nc3dx>JYP)~L!$L* K{`tul)bauJ7#3du delta 69 zcmdn*x8H9<6$cl;rbV}o`sR&IoN6KlA%><_CWcm~X4(b@Rt5%V_R1}tJYP)~Lt^iP LWs;LGsO19y;+qwH diff --git a/apple-touch-icon-152x152.png b/apple-touch-icon-152x152.png index 9bd1cb3e37cc4f996c51e81ec53bf75b3af3265c..03e901b1986ffd92bfeff314c949123c64fc0d90 100644 GIT binary patch delta 69 zcmcbWek*-K6$c-mn4+a+g#N~+B}O79A%-SaMn+b~#@Yr3Rt5$^=kFY!Y-KEqA)!1e KrFwFMeLJUo)!ag8WR jNi0dV%FR#7OsixtGB7gIH89gPMAzWp6zDj)-8LTpZwniJ delta 93 zcmexX{jGXJ6$cl;rd6tv+x(492W(soLJUo)!ag8WR jNi0dV%FR#7OsixtGB7gIH89gPMAz{4{#}>J?Y8*d8k1@&UM`8E*gp delta 93 zcmdm@v_)w`6$cl;rs>zY(R>@5{_(pSgczDynHXA`8fzOESQ!}1Yc*tIU|>)!ag8WR jNi0dV%FR#7OsixtGB7gIH89gPMAz{CM(4iCM+Nc$Cx#qS diff --git a/apple-touch-icon-76x76.png b/apple-touch-icon-76x76.png index 466d431d9c7bae107d5f18fd150af9453a665c7e..f5651bbdbc3d83d7cd8b44b854f09a7dc4cad497 100644 GIT binary patch delta 69 zcmcbqdsBBp6$c-mm|TB+snEuz#iAl6A%-SaMn+b~2HFM&Rt5&i>c^rcTZ+kINC;Kc KJ)4{*mJa~J{S&MJ delta 69 zcmcbqdsBBp6$cl;rdiGut}Ppz7K@4)gczDynHXA`nrIssSQ!{ZEAjVCwiJ`akkG2% KZZJ7ZEFS>K=Mysk diff --git a/apple-touch-icon.png b/apple-touch-icon.png index f15e5df73febece43f6cb404c03aa57ea6e4b578..4cd5c5a13f79306a579a50704f2bd2ce39956be4 100644 GIT binary patch delta 93 zcmexX{jGXJ6$c-mn2Klcngtu14%oPwgczDw85vm_n`s*uSQ!{FeE*!lz`&qd;u=ws jl30>zm7AZEnO4bQWME{ZYhb2ph_0b -

Site built with pkgdown 2.0.3.

+

Site built with pkgdown 2.0.4.

diff --git a/favicon-16x16.png b/favicon-16x16.png index 1669955fd12dc830bd0320b2ad17f46867f5b77e..48110b7763824cf2c4aed372eade7dfc46cc4515 100644 GIT binary patch delta 70 zcmaFQ@t$KtKNANZpP2T|HyaH%PiInL6fp@gG_f)=vNAE&HZZUq{? J5iyA)9{{FQ6LA0l delta 68 zcmaDa@Lpg-6$cl;7Dw9+mpdDqEZId2LJUo

-

Site built with pkgdown 2.0.3.

+

Site built with pkgdown 2.0.4.

diff --git a/news/index.html b/news/index.html index 8dbbafcc7..76af51f23 100644 --- a/news/index.html +++ b/news/index.html @@ -76,7 +76,6 @@

  • Closed #3397: renderPlot() new uses ggplot2::get_alt_text() to inform an alt text default (for ggplot2 plots). (#3398)

  • modalDialog() gains support for size = "xl". (#3410)

  • Addressed #2521: Updated the list of TCP ports that will be rejected by default in runapp.R, adding 5060, 5061 and 6566. Added documentation describing the port range (3000:8000) and which ports are rejected. (#3456)

    • -

  • fileInput() can set the capture attribute to facilitates user access to a device’s media capture mechanism, such as a camera, or microphone, from within a file upload control (W3C HTML Media Capture). (Thanks to khaled-alshamaa, #3481)

    • Other improvements

    @@ -88,7 +87,7 @@

    Bug fixes

    • Closed #3345: Shiny now correctly renders htmltools::htmlDependency()(s) with a list() of script attributes when used in a dynamic UI context. This fairly new htmlDependency() feature was added in htmltools v0.5.1. (#3395)

      • -

    • Fixed #2666 and #2670: nearPoints() and brushedPoints() weren’t properly account for missing values (#2666 was introduced in v1.4.0). (#2668)

      • +

    • Fixed #2666 and #2670: nearPoints() and brushedPoints() weren’t properly account for missing values (#2666 was introduced in v1.4.0). (#2668)

    • Closed #3374: quoToFunction() now works correctly with nested quosures; and as a result, quasi-quotation with rendering function (e.g., renderPrint(), renderPlot(), etc) now works as expected with nested quosures. (#3373)

    • Exported register_devmode_option(). This method was described in the documentation for devmode() but was never exported. See ?devmode() for more details on how to register Shiny Developer options using register_devmode_option(). (#3364)

    • Closed #3484: In the RStudio IDE on Mac 11.5, selected checkboxes and radio buttons were not visible. (#3485)

      • @@ -182,7 +181,7 @@

      New features

      • The new shinyAppTemplate() function creates a new template Shiny application, where components are optional, such as helper files in an R/ subdirectory, a module, and various kinds of tests. (#2704)

      • runTests() is a new function that behaves much like R CMD check. runTests() invokes all of the top-level R files in the tests/ directory inside an application, in that application’s environment. (#2585)

        • -

      • testServer() is a new function for testing reactive behavior inside server functions and modules. (#2682, #2764, #2807)

        • +

      • testServer() is a new function for testing reactive behavior inside server functions and modules. (#2682, #2764, #2807)

      • The new moduleServer function provides a simpler interface for creating and using modules. (#2773)

      • Resolved #2732: markdown() is a new function for writing Markdown with Github extensions directly in Shiny UIs. Markdown rendering is performed by the commonmark package. (#2737)

      • The getCurrentOutputInfo() function can now return the background color (bg), foreground color (fg), accent (i.e., hyperlink) color, and font information of the output’s HTML container. This information is reported by plotOutput(), imageOutput(), and any other output bindings containing a class of .shiny-report-theme. This feature allows developers to style an output’s contents based on the container’s CSS styling. (#2740)

        • @@ -365,9 +364,9 @@

      • Addressed #1851: Stack traces are now smaller in some places do.call() is used. (#1856)

      • Stack traces have been improved, with more aggressive de-noising and support for deep stack traces (stitching together multiple stack traces that are conceptually part of the same async operation).

      • Addressed #1859: Server-side selectize is now significantly faster. (Thanks to @dselivanov #1861)

        • -

      • #1989: The server side of outputs can now be removed (e.g. output$plot <- NULL). This is not usually necessary but it does allow some objects to be garbage collected, which might matter if you are dynamically creating and destroying many outputs. (Thanks, @mmuurr! #2011)

        • +

      • #1989: The server side of outputs can now be removed (e.g. output$plot <- NULL). This is not usually necessary but it does allow some objects to be garbage collected, which might matter if you are dynamically creating and destroying many outputs. (Thanks, @mmuurr! #2011)

      • Removed the (ridiculously outdated) “experimental feature” tag from the reference documentation for renderUI. (#2036)

        • -

      • Addressed #1907: the ignoreInit argument was first added only to observeEvent. Later, we also added it to eventReactive, but forgot to update the documentation. Now done, thanks @flo12392! (#2036)

        • +

      • Addressed #1907: the ignoreInit argument was first added only to observeEvent. Later, we also added it to eventReactive, but forgot to update the documentation. Now done, thanks @flo12392! (#2036)

    Bug fixes

    @@ -417,7 +416,7 @@

    Minor new features and improvements

    -

    • Addressed #1688: trigger a new shiny:outputinvalidated event when an output gets invalidated, at the same time that the recalculating CSS class is added. (#1758, thanks @andrewsali!)

      • +

      • Addressed #1688: trigger a new shiny:outputinvalidated event when an output gets invalidated, at the same time that the recalculating CSS class is added. (#1758, thanks @andrewsali!)

      • Addressed #1508: fileInput now permits the same file to be uploaded multiple times. (#1719)

      • Addressed #1501: The fileInput control now retains uploaded file extensions on the server. This fixes readxl’s readxl::read_excel and other functions that must recognize a file’s extension in order to work. (#1706)

      • For conditionalPanels, Shiny now gives more informative messages if there are errors evaluating or parsing the JavaScript conditional expression. (#1727)

        • @@ -705,8 +704,8 @@

      • Added support for horizontal dividers in navbarMenu. (#1147)

      • Added placeholder option to passwordInput. (#1152)

      • Added session$resetBrush(brushId) (R) and Shiny.resetBrush(brushId) (JS) to programatically clear brushes from imageOutput/plotOutput. (#1197)

        • -

      • Added textAreaInput. (thanks, @nuno-agostinho! #1300)

        • -

      • Added session$sendBinaryMessage(type, message) method for sending custom binary data to the client. See ?session. (thanks, @daef! #1316 and #1320)

        • +

      • Added textAreaInput. (thanks, @nuno-agostinho! #1300)

        • +

      • Added session$sendBinaryMessage(type, message) method for sending custom binary data to the client. See ?session. (thanks, @daef! #1316 and #1320)

      • Almost all code examples now have a runnable example with shinyApp(), so that users can run the examples and see them in action. (#1158)

      • When resized, plots are drawn with replayPlot(), instead of re-executing all plotting code. This results in faster plot rendering. (#1112)

      • Exported the isTruthy() function. (part of PR #1272)

        • @@ -717,14 +716,14 @@

        Bug fixes

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/pkgdown.yml b/pkgdown.yml index 67ff4e08d..bb18b5c1d 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,6 +1,6 @@ pandoc: 2.7.3 -pkgdown: 2.0.3 +pkgdown: 2.0.4 pkgdown_sha: ~ articles: {} -last_built: 2022-06-10T15:42Z +last_built: 2022-06-14T14:22Z diff --git a/reference/MockShinySession.html b/reference/MockShinySession.html index 4e7c80429..ab7f00a6f 100644 --- a/reference/MockShinySession.html +++ b/reference/MockShinySession.html @@ -734,7 +734,7 @@ output, or NULL if no output is currently executing.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/NS.html b/reference/NS.html index b53aa188d..c6831e470 100644 --- a/reference/NS.html +++ b/reference/NS.html @@ -74,12 +74,17 @@ any length, though a single element is most common. Length 0 will cause the id to be returned without a namespace, and length 2 will be interpreted as multiple namespaces, in increasing order of specificity (i.e. starting with the top-level namespace).

    + +
    id

    The id string to be namespaced (optional).

    +

    Value

    -

    If id is missing, returns a function that expects an id string + + +

    If id is missing, returns a function that expects an id string as its only argument and returns that id with the namespace prepended.

    @@ -108,7 +113,7 @@ into a namespaced one, by combining them with ns.sep in between.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/Progress.html b/reference/Progress.html index 42a0b2736..00b1d0471 100644 --- a/reference/Progress.html +++ b/reference/Progress.html @@ -287,7 +287,7 @@ relative to message.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/absolutePanel.html b/reference/absolutePanel.html index c8462f093..d96f0b8e2 100644 --- a/reference/absolutePanel.html +++ b/reference/absolutePanel.html @@ -84,28 +84,46 @@
    ...

    Attributes (named arguments) or children (unnamed arguments) that should be included in the panel.

    + +
    top

    Distance between the top of the panel, and the top of the page or parent container.

    + +
    left

    Distance between the left side of the panel, and the left of the page or parent container.

    + +
    right

    Distance between the right side of the panel, and the right of the page or parent container.

    + +
    bottom

    Distance between the bottom of the panel, and the bottom of the page or parent container.

    + +
    width

    Width of the panel.

    + +
    height

    Height of the panel.

    + +
    draggable

    If TRUE, allows the user to move the panel by clicking and dragging.

    + +
    fixed

    Positions the panel relative to the browser window and prevents it from being scrolled with the rest of the page.

    + +
    cursor

    The type of cursor that should appear when the user mouses over the panel. Use "move" for a north-east-south-west icon, @@ -113,10 +131,13 @@ the panel. Use "move" for a north-east-south-west icon, usual cursor behavior (including changing to an I-beam when the cursor is over text). The default is "auto", which is equivalent to ifelse(draggable, "move", "inherit").

    +

    Value

    -

    An HTML element or list of elements.

    + + +

    An HTML element or list of elements.

    Details

    @@ -155,7 +176,7 @@ rather than the more obvious width = "100%" and height = "100
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/actionButton.html b/reference/actionButton.html index 174ee2e61..497628cfc 100644 --- a/reference/actionButton.html +++ b/reference/actionButton.html @@ -64,16 +64,25 @@ each time it is pressed.

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    The contents of the button or link--usually a text label, but you could also use any other HTML, like an image.

    + +
    icon

    An optional icon() to appear on the button.

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    ...

    Named attributes to be applied to the button or link.

    +

    Server value

    @@ -151,7 +160,7 @@ This implies two things:

    diff --git a/reference/applyInputHandlers.html b/reference/applyInputHandlers.html index c040c2f98..25011dcb4 100644 --- a/reference/applyInputHandlers.html +++ b/reference/applyInputHandlers.html @@ -66,8 +66,11 @@ values.

    Arguments

    inputs

    A named list of input values.

    + +
    shinysession

    A Shiny session object.

    +

    Details

    @@ -93,7 +96,7 @@ output.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/bindCache.html b/reference/bindCache.html index a85517329..3438c5008 100644 --- a/reference/bindCache.html +++ b/reference/bindCache.html @@ -72,12 +72,17 @@ cache) and they can be shared across user sessions. This allows

    Arguments

    x

    The object to add caching to.

    + +
    ...

    One or more expressions to use in the caching key.

    + +
    cache

    The scope of the cache, or a cache object. This can be "app" (the default), "session", or a cache object like a cachem::cache_disk(). See the Cache Scoping section for more information.

    +

    Details

    @@ -192,18 +197,21 @@ persists beyond the current R session.

    shinyOptions() at the top of your app.R, server.R, or global.R. For example, this will create a cache with 500 MB of space instead of the default 200 MB:

    -

    +

    shinyOptions(cache = cachem::cache_mem(max_size = 500e6))

    To use different settings for a session-scoped cache, you can set self$cache at the top of your server function. By default, it will create a 200 MB memory cache for each session, but you can replace it with something different. To use the session-scoped cache, you must also call bindCache() with cache="session". This will create a 100 MB cache for the session:

    -

    +

    function(input, output, session) {
+  session$cache <- cachem::cache_mem(max_size = 100e6)
+  ...
+}

    If you want to use a cache that is shared across multiple R processes, you can use a cachem::cache_disk(). You can create a application-level shared cache by putting this at the top of your app.R, server.R, or global.R:

    -

    +

    shinyOptions(cache = cachem::cache_disk(file.path(dirname(tempdir()), "myapp-cache"))

    This will create a subdirectory in your system temp directory named myapp-cache (replace myapp-cache with a unique name of your choosing). On most platforms, this directory will be removed when @@ -212,7 +220,7 @@ stops of the R process, as long as you do not reboot.

    To have the cache persist even across multiple reboots, you can create the cache in a location outside of the temp directory. For example, it could be a subdirectory of the application:

    -

    +

    shinyOptions(cache = cachem::cache_disk("./myapp-cache"))

    In this case, resetting the cache will have to be done manually, by deleting the directory.

    You can also scope a cache to just one item, or selected items. To do that, @@ -273,7 +281,8 @@ the cache.

    htmlwidgets::shinyRenderWidget(), if you've authored an htmlwidget) in order for bindCache() to correctly compute a cache key.

    The potential problem is a cache collision. Consider the following:

    -

    +

    output$x1 <- renderText({ input$x }) %>% bindCache(input$x)
+output$x2 <- renderText({ input$x * 2 }) %>% bindCache(input$x)

    Both output$x1 and output$x2 use input$x as part of their cache key, but if it were the only thing used in the cache key, then the two outputs would have a cache collision, and they would have the same output. To avoid @@ -307,7 +316,16 @@ that may influence the final value.

    again, you can inspect the cache hint with shiny:::extractCacheHint() and also test it in an application. If you do need to explicitly provide a cache hint, pass it to shinyRenderWidget. For example:

    -

    +

    renderMyWidget <- function(expr) {
+  q <- rlang::enquo0(expr)
+
+  htmlwidgets::shinyRenderWidget(
+    q,
+    myWidgetOutput,
+    quoted = TRUE,
+    cacheHint = list(label = "myWidget", userQuo = q)
+  )
+}

    If your render function sets any internal state, you may find it useful in your call to createRenderFunction() to use the cacheWriteHook and/or cacheReadHook parameters. These hooks are @@ -339,7 +357,7 @@ in order to work properly.

    When bindCache() is used with renderPlot(), the height and width passed to the original renderPlot() are ignored. They are superseded by sizePolicy argument passed to `bindCache. The default is:

    -

    +

    sizePolicy = sizeGrowthRatio(width = 400, height = 400, growthRate = 1.2)

    sizePolicy must be a function that takes a two-element numeric vector as input, representing the width and height of the <img> element in the browser window, and it must return a two-element numeric vector, representing @@ -461,7 +479,7 @@ See sizeGrowthRatio() for more i

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/bindEvent.html b/reference/bindEvent.html index b85e35e00..4a5a24a56 100644 --- a/reference/bindEvent.html +++ b/reference/bindEvent.html @@ -86,26 +86,37 @@ with bindCache(), and it can also be u
    x

    An object to wrap so that is triggered only when a the specified event occurs.

    + +
    ...

    One or more expressions that represents the event; this can be a simple reactive value like input$click, a call to a reactive expression like dataset(), or even a complex expression inside curly braces. If there are multiple expressions in the ..., then it will take a dependency on all of them.

    + +
    ignoreNULL

    Whether the action should be triggered (or value calculated) when the input is NULL. See Details.

    + +
    ignoreInit

    If TRUE, then, when the eventified object is first created/initialized, don't trigger the action or (compute the value). The default is FALSE. See Details.

    + +
    once

    Used only for observers. Whether this observer should be immediately destroyed after the first time that the code in the observer is run. This pattern is useful when you want to subscribe to a event that should only happen once.

    + +
    label

    A label for the observer or reactive, useful for debugging.

    +

    Details

    @@ -240,7 +251,7 @@ expression given to bindEvent(), and not the cache key expression g
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/bookmarkButton.html b/reference/bookmarkButton.html index f19609ad1..938fb8794 100644 --- a/reference/bookmarkButton.html +++ b/reference/bookmarkButton.html @@ -71,19 +71,28 @@ used for bookmarking state.

    label

    The contents of the button or link--usually a text label, but you could also use any other HTML, like an image.

    + +
    icon

    An optional icon() to appear on the button.

    + +
    title

    A tooltip that is shown when the mouse cursor hovers over the button.

    + +
    ...

    Named attributes to be applied to the button or link.

    + +
    id

    An ID for the bookmark button. The only time it is necessary to set the ID unless you have more than one bookmark button in your application. If you specify an input ID, it should be excluded from bookmarking with setBookmarkExclude(), and you must create an observer that does the bookmarking when the button is pressed. See the examples below.

    +

    See also

    @@ -140,7 +149,7 @@ does the bookmarking when the button is pressed. See the examples below.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/bootstrapLib.html b/reference/bootstrapLib.html index ed64664c9..ff5580c2c 100644 --- a/reference/bootstrapLib.html +++ b/reference/bootstrapLib.html @@ -67,6 +67,7 @@ build of Bootstrap 3 with a customized version of Bootstrap 3 or higher.

    A character string pointing to an alternative Bootstrap stylesheet (normally a css file within the www directory, e.g. www/bootstrap.css).

    +

    Details

    @@ -87,7 +88,7 @@ others which use bootstrapPage, such
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/bootstrapPage.html b/reference/bootstrapPage.html index c989bdc67..222ea5b3c 100644 --- a/reference/bootstrapPage.html +++ b/reference/bootstrapPage.html @@ -66,8 +66,12 @@ body (other than what you provide).

    Arguments

    ...

    The contents of the document body.

    + +
    title

    The browser window title (defaults to the host URL of the page)

    + +
    theme

    One of the following:

    • NULL (the default), which implies a "stock" build of Bootstrap 3.

    • A bslib::bs_theme() object. This can be used to replace a stock @@ -75,14 +79,19 @@ build of Bootstrap 3 with a customized version of Bootstrap 3 or higher.

      • A character string pointing to an alternative Bootstrap stylesheet (normally a css file within the www directory, e.g. www/bootstrap.css).

    + +
    lang

    ISO 639-1 language code for the HTML page, such as "en" or "ko". This will be used as the lang in the <html> tag, as in <html lang="en">. The default (NULL) results in an empty string.

    +

    Value

    -

    A UI definition that can be passed to the shinyUI function.

    + + +

    A UI definition that can be passed to the shinyUI function.

    Details

    @@ -113,7 +122,7 @@ and know how to lay out pages in Bootstrap. Most applications should use
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/brushOpts.html b/reference/brushOpts.html index 2904ef8bb..b348dc55e 100644 --- a/reference/brushOpts.html +++ b/reference/brushOpts.html @@ -78,39 +78,56 @@ then the coordinates will be available as input$plot_brush. Multipl imageOutput/plotOutput calls may share the same id value; brushing one image or plot will cause any other brushes with the same id to disappear.

    + +
    fill

    Fill color of the brush. If 'auto', it derives from the link color of the plot's HTML container (if thematic is enabled, and accent is a non-'auto' value, that color is used instead).

    + +
    stroke

    Outline color of the brush. If 'auto', it derives from the foreground color of the plot's HTML container (if thematic is enabled, and fg is a non-'auto' value, that color is used instead).

    + +
    opacity

    Opacity of the brush

    + +
    delay

    How long to delay (in milliseconds) when debouncing or throttling, before sending the brush data to the server.

    + +
    delayType

    The type of algorithm for limiting the number of brush events. Use "throttle" to limit the number of brush events to one every delay milliseconds. Use "debounce" to suspend events while the cursor is moving, and wait until the cursor has been at rest for delay milliseconds before sending an event.

    + +
    clip

    Should the brush area be clipped to the plotting area? If FALSE, then the user will be able to brush outside the plotting area, as long as it is still inside the image.

    + +
    direction

    The direction for brushing. If "xy", the brush can be drawn and moved in both x and y directions. If "x", or "y", the brush wil work horizontally or vertically.

    + +
    resetOnNew

    When a new image is sent to the browser (via renderImage()), should the brush be reset? The default, FALSE, is useful if you want to update the plot while keeping the brush. Using TRUE is useful if you want to clear the brush whenever the plot is updated.

    +

    See also

    @@ -129,7 +146,7 @@ the plot is updated.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/brushedPoints.html b/reference/brushedPoints.html index f5814df69..9fc3ea894 100644 --- a/reference/brushedPoints.html +++ b/reference/brushedPoints.html @@ -89,39 +89,58 @@ rows of the would be selected.

    Arguments

    df

    A data frame from which to select rows.

    + +
    brush, coordinfo

    The data from a brush or click/dblclick/hover event e.g. input$plot_brush, input$plot_click.

    + +
    xvar, yvar

    A string giving the name of the variable on the x or y axis. These are only required for base graphics, and must be the name of a column in df.

    + +
    panelvar1, panelvar2

    A string giving the name of a panel variable. For expert use only; in most cases these will be automatically derived from the ggplot2 spec.

    + +
    allRows

    If FALSE (the default) return a data frame containing the selected rows. If TRUE, the input data frame will have a new column, selected_, which indicates whether the row was selected or not.

    + +
    threshold

    A maximum distance (in pixels) to the pointer location. Rows in the data frame will be selected if the distance to the pointer is less than threshold.

    + +
    maxpoints

    Maximum number of rows to return. If NULL (the default), will return all rows within the threshold distance.

    + +
    addDist

    If TRUE, add a column named dist_ that contains the distance from the coordinate to the point, in pixels. When no pointer event has yet occurred, the value of dist_ will be NA.

    +

    Value

    -

    A data frame based on df, containing the observations selected by the + + +

    A data frame based on df, containing the observations selected by the brush or near the click event. For nearPoints(), the rows will be sorted -by distance to the event. -If allRows = TRUE, then all rows will returned, along with a new +by distance to the event.

    + + +

    If allRows = TRUE, then all rows will returned, along with a new selected_ column that indicates whether or not the point was selected. The output from nearPoints() will no longer be sorted, but you can set addDist = TRUE to get an additional column that gives the pixel @@ -182,7 +201,7 @@ using just the x or y variable, whichever is appropriate.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/callModule.html b/reference/callModule.html index 03afa05af..d664f24be 100644 --- a/reference/callModule.html +++ b/reference/callModule.html @@ -66,18 +66,27 @@ to understand, and modules created with moduleServer can be tested

    Arguments

    module

    A Shiny module server function

    + +
    id

    An ID string that corresponds with the ID used to call the module's UI function

    + +
    ...

    Additional parameters to pass to module server function

    + +
    session

    Session from which to make a child scope (the default should almost always be used)

    +

    Value

    -

    The return value, if any, from executing the module server function

    + + +

    The return value, if any, from executing the module server function

    @@ -92,7 +101,7 @@ almost always be used)

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/checkboxGroupInput.html b/reference/checkboxGroupInput.html index 653efb7b7..ccba12870 100644 --- a/reference/checkboxGroupInput.html +++ b/reference/checkboxGroupInput.html @@ -73,21 +73,33 @@ selected values.

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    choices

    List of values to show checkboxes for. If elements of the list are named then that name rather than the value is displayed to the user. If this argument is provided, then choiceNames and choiceValues must not be provided, and vice-versa. The values should be strings; other types (such as logicals and numbers) will be coerced to strings.

    + +
    selected

    The values that should be initially selected, if any.

    + +
    inline

    If TRUE, render the choices inline (i.e. horizontally)

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    choiceNames, choiceValues

    List of names and values, respectively, that are displayed to the user in the app and correspond to the each @@ -98,10 +110,13 @@ provided, then the other must be provided and choices a named list for choices is that choiceNames allows any type of UI object to be passed through (tag objects, icons, HTML code, ...), instead of just simple text. See Examples.

    +

    Value

    -

    A list of HTML elements that can be added to a UI definition.

    + + +

    A list of HTML elements that can be added to a UI definition.

    Server value

    @@ -184,7 +199,7 @@ type of UI object to be passed through (tag objects, icons, HTML code,
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/checkboxInput.html b/reference/checkboxInput.html index 19e0786de..23ad1c647 100644 --- a/reference/checkboxInput.html +++ b/reference/checkboxInput.html @@ -60,17 +60,26 @@

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    value

    Initial value (TRUE or FALSE).

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    +

    Value

    -

    A checkbox control that can be added to a UI definition.

    + + +

    A checkbox control that can be added to a UI definition.

    Server value

    @@ -127,7 +136,7 @@ see
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/clickOpts.html b/reference/clickOpts.html index 60a8d935f..696b3c6bd 100644 --- a/reference/clickOpts.html +++ b/reference/clickOpts.html @@ -73,25 +73,34 @@ hover events generated by imageOutput() and plotOutput().">, then the event data will be available as input$plot_click.

    + +
    clip

    Should the click area be clipped to the plotting area? If FALSE, then the server will receive click events even when the mouse is outside the plotting area, as long as it is still inside the image.

    + +
    delay

    For dblClickOpts(): the maximum delay (in ms) between a pair clicks for them to be counted as a double-click.

    For hoverOpts(): how long to delay (in ms) when debouncing or throttling before sending the mouse location to the server.

    + +
    delayType

    The type of algorithm for limiting the number of hover events. Use "throttle" to limit the number of hover events to one every delay milliseconds. Use "debounce" to suspend events while the cursor is moving, and wait until the cursor has been at rest for delay milliseconds before sending an event.

    + +
    nullOutside

    If TRUE (the default), the value will be set to NULL when the mouse exits the plotting area. If FALSE, the value will stop changing when the cursor exits the plotting area.

    +

    See also

    @@ -110,7 +119,7 @@ value will stop changing when the cursor exits the plotting area.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/column.html b/reference/column.html index eab139f4f..d5f09cb7a 100644 --- a/reference/column.html +++ b/reference/column.html @@ -62,15 +62,22 @@ fixedRow()">Arguments
    width

    The grid width of the column (must be between 1 and 12)

    + +
    ...

    Elements to include within the column

    + +
    offset

    The number of columns to offset this column from the end of the previous column.

    +

    Value

    -

    A column that can be included within a + + +

    A column that can be included within a fluidRow() or fixedRow().

    @@ -131,7 +138,7 @@ previous column.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/conditionalPanel.html b/reference/conditionalPanel.html index fd62c09c8..219578e1a 100644 --- a/reference/conditionalPanel.html +++ b/reference/conditionalPanel.html @@ -65,11 +65,16 @@ whenever Shiny detects a relevant change in input/output.

    condition

    A JavaScript expression that will be evaluated repeatedly to determine whether the panel should be displayed.

    + +
    ...

    Elements to include in the panel.

    + +
    ns

    The namespace() object of the current module, if any.

    +

    Details

    @@ -150,7 +155,7 @@ value.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/createRenderFunction.html b/reference/createRenderFunction.html index 6aa2c329f..feb3e35fa 100644 --- a/reference/createRenderFunction.html +++ b/reference/createRenderFunction.html @@ -93,16 +93,22 @@ additional call(s).

    A function without parameters, that returns user data. If the returned value is a promise, then the render function will proceed in async mode.

    + +
    transform

    A function that takes four arguments: value, session, name, and ... (for future-proofing). This function will be invoked each time a value is returned from func, and is responsible for changing the value into a JSON-ready value to be JSON-encoded and sent to the browser.

    + +
    outputFunc

    The UI function that is used (or most commonly used) with this render function. This can be used in R Markdown documents to create complete output widgets out of just the render function.

    + +
    outputArgs

    A list of arguments to pass to the uiFunc. Render functions should include outputArgs = list() in their own parameter list, @@ -110,18 +116,24 @@ and pass through the value to markRenderFunction, to allow app auth customize outputs. (Currently, this is only supported for dynamically generated UIs, such as those created by Shiny code snippets embedded in R Markdown documents).

    + +
    cacheHint

    One of "auto", FALSE, or some other information to identify this instance for caching using bindCache(). If "auto", it will try to automatically infer caching information. If FALSE, do not allow caching for the object. Some render functions (such as renderPlot) contain internal state that makes them unsuitable for caching.

    + +
    cacheWriteHook

    Used if the render function is passed to bindCache(). This is an optional callback function to invoke before saving the value from the render function to the cache. This function must accept one argument, the value returned from renderFunc, and should return the value to store in the cache.

    + +
    cacheReadHook

    Used if the render function is passed to bindCache(). This is an optional callback function to invoke after reading a value from @@ -130,31 +142,50 @@ argument, the value retrieved from the cache. This can be useful when some side effect needs to occur for a render function to behave correctly. For example, some render functions call createWebDependency() so that Shiny is able to serve JS and CSS resources.

    + +
    q

    Quosure of the expression x. When capturing expressions to create your quosure, it is recommended to use enquo0() to not unquote the object too early. See enquo0() for more details.

    + +
    label

    A label for the object to be shown in the debugger. Defaults to the name of the calling function.

    + +
    expr

    A quoted or unquoted expression, or a quosure.

    + +
    name

    The name the function should be given

    + +
    eval.env

    The desired environment for the function. Defaults to the calling environment two steps back.

    + +
    quoted

    Is the expression quoted?

    + +
    assign.env

    The environment in which the function should be assigned.

    + +
    wrappedWithLabel, ..stacktraceon

    Advanced use only. For stack manipulation purposes; see stacktrace().

    +

    Value

    -

    An annotated render function, ready to be assigned to an + + +

    An annotated render function, ready to be assigned to an output slot.

    @@ -258,7 +289,7 @@ function that's assigned to a name in the assign.env.<
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/createWebDependency.html b/reference/createWebDependency.html index fe5e309a3..cf6c8e5ec 100644 --- a/reference/createWebDependency.html +++ b/reference/createWebDependency.html @@ -68,16 +68,21 @@ URL.

    A single HTML dependency object, created using htmltools::htmlDependency(). If the src value is named, then href and/or file names must be present.

    + +
    scrubFile

    If TRUE (the default), remove src$file for the dependency. This prevents the local file path from being sent to the client when dynamic web dependencies are used. If FALSE, don't remove src$file. Setting it to FALSE should be needed only in very unusual cases.

    +

    Value

    -

    A single HTML dependency object that has an href-named element + + +

    A single HTML dependency object that has an href-named element in its src.

    @@ -93,7 +98,7 @@ in its src.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/dateInput.html b/reference/dateInput.html index 4df862734..93c4af578 100644 --- a/reference/dateInput.html +++ b/reference/dateInput.html @@ -76,27 +76,43 @@ the user can click on to select dates.

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    value

    The starting date. Either a Date object, or a string in yyyy-mm-dd format. If NULL (the default), will use the current date in the client's time zone.

    + +
    min

    The minimum allowed date. Either a Date object, or a string in yyyy-mm-dd format.

    + +
    max

    The maximum allowed date. Either a Date object, or a string in yyyy-mm-dd format.

    + +
    format

    The format of the date to display in the browser. Defaults to "yyyy-mm-dd".

    + +
    startview

    The date range shown when the input object is first clicked. Can be "month" (the default), "year", or "decade".

    + +
    weekstart

    Which day is the start of the week. Should be an integer from 0 (Sunday) to 6 (Saturday).

    + +
    language

    The language used for month and day names. Default is "en". Other valid values include "ar", "az", "bg", "bs", "ca", "cs", "cy", "da", @@ -106,18 +122,27 @@ Other valid values include "ar", "az", "bg", "bs", "ca", "cs", "cy", "da", "nb", "nl-BE", "nl", "no", "pl", "pt-BR", "pt", "ro", "rs-latin", "rs", "ru", "sk", "sl", "sq", "sr-latin", "sr", "sv", "sw", "th", "tr", "uk", "vi", "zh-CN", and "zh-TW".

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    autoclose

    Whether or not to close the datepicker immediately when a date is selected.

    + +
    datesdisabled

    Which dates should be disabled. Either a Date object, or a string in yyyy-mm-dd format.

    + +
    daysofweekdisabled

    Days of the week that should be disabled. Should be a integer vector with values from 0 (Sunday) to 6 (Saturday).

    +

    Details

    @@ -211,7 +236,7 @@ the browser. It allows the following values:

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/dateRangeInput.html b/reference/dateRangeInput.html index 7164c2f65..f68562975 100644 --- a/reference/dateRangeInput.html +++ b/reference/dateRangeInput.html @@ -76,31 +76,49 @@ the user can click on to select dates.

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    start

    The initial start date. Either a Date object, or a string in yyyy-mm-dd format. If NULL (the default), will use the current date in the client's time zone.

    + +
    end

    The initial end date. Either a Date object, or a string in yyyy-mm-dd format. If NULL (the default), will use the current date in the client's time zone.

    + +
    min

    The minimum allowed date. Either a Date object, or a string in yyyy-mm-dd format.

    + +
    max

    The maximum allowed date. Either a Date object, or a string in yyyy-mm-dd format.

    + +
    format

    The format of the date to display in the browser. Defaults to "yyyy-mm-dd".

    + +
    startview

    The date range shown when the input object is first clicked. Can be "month" (the default), "year", or "decade".

    + +
    weekstart

    Which day is the start of the week. Should be an integer from 0 (Sunday) to 6 (Saturday).

    + +
    language

    The language used for month and day names. Default is "en". Other valid values include "ar", "az", "bg", "bs", "ca", "cs", "cy", "da", @@ -110,14 +128,21 @@ Other valid values include "ar", "az", "bg", "bs", "ca", "cs", "cy", "da", "nb", "nl-BE", "nl", "no", "pl", "pt-BR", "pt", "ro", "rs-latin", "rs", "ru", "sk", "sl", "sq", "sr-latin", "sr", "sv", "sw", "th", "tr", "uk", "vi", "zh-CN", and "zh-TW".

    + +
    separator

    String to display between the start and end input boxes.

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    autoclose

    Whether or not to close the datepicker immediately when a date is selected.

    +

    Details

    @@ -215,7 +240,7 @@ the browser. It allows the following values:

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/debounce.html b/reference/debounce.html index 56fe746f3..fe19eed32 100644 --- a/reference/debounce.html +++ b/reference/debounce.html @@ -74,17 +74,24 @@ invalidation signals; see Details.

    Arguments

    r

    A reactive expression (that invalidates too often).

    + +
    millis

    The debounce/throttle time window. You may optionally pass a no-arg function or reactive expression instead, e.g. to let the end-user control the time window.

    + +
    priority

    Debounce/throttle is implemented under the hood using observers. Use this parameter to set the priority of these observers. Generally, this should be higher than the priorities of downstream observers and outputs (which default to zero).

    + +
    domain

    See domains.

    +

    Details

    @@ -185,7 +192,7 @@ has expired.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/devmode.html b/reference/devmode.html index b1cc0e6ed..2e2d83ea1 100644 --- a/reference/devmode.html +++ b/reference/devmode.html @@ -97,37 +97,60 @@ by calling devmode(FALSE).

    devmode

    Logical value which should be set to TRUE to enable Shiny Developer Mode

    + +
    verbose

    Logical value which should be set to TRUE display Shiny Developer messages

    + +
    code

    Code to execute with the temporary Dev Mode options set

    + +
    message

    Developer Mode message to be sent to rlang::inform()

    + +
    .frequency

    Frequency of the Developer Mode message used with rlang::inform(). Defaults to once every 8 hours.

    + +
    .frequency_id

    rlang::inform() message identifier. Defaults to message.

    + +
    .file

    Output connection for rlang::inform(). Defaults to stderr()

    + +
    ...

    Parameters passed to rlang::inform()

    + +
    name

    Name of option to look for in options()

    + +
    devmode_message

    Message to display once every 8 hours when utilizing the devmode_default value. If devmode_message is missing, the registered devmode_message value be used.

    + +
    devmode_default

    Default value to return if in_devmode() returns TRUE and the specified option is not set in options(). For get_devmode_option(), if devmode_default is missing, the registered devmode_default value will be used.

    + +
    default

    Default value to return if in_devmode() returns TRUE and the specified option is not set in options().

    +

    Functions

    @@ -300,7 +323,7 @@ not recommended for all reimplementation situations.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/diskCache.html b/reference/diskCache.html index d0eb1c1e2..fb2b6f258 100644 --- a/reference/diskCache.html +++ b/reference/diskCache.html @@ -71,36 +71,53 @@
    dir

    Directory to store files for the cache. If NULL (the default) it will create and use a temporary directory.

    + +
    max_size

    Maximum size of the cache, in bytes. If the cache exceeds this size, cached objects will be removed according to the value of the evict. Use Inf for no size limit. The default is 1 gigabyte.

    + +
    max_age

    Maximum age of files in cache before they are evicted, in seconds. Use Inf for no age limit.

    + +
    max_n

    Maximum number of objects in the cache. If the number of objects exceeds this value, then cached objects will be removed according to the value of evict. Use Inf for no limit of number of items.

    + +
    evict

    The eviction policy to use to decide which objects are removed when a cache pruning occurs. Currently, "lru" and "fifo" are supported.

    + +
    destroy_on_finalize

    If TRUE, then when the cache_disk object is garbage collected, the cache directory and all objects inside of it will be deleted from disk. If FALSE (the default), it will do nothing when finalized.

    + +
    missing

    A value to return when get(key) is called but the key is not present in the cache. The default is a key_missing() object. It is actually an expression that is evaluated each time there is a cache miss. See section Missing keys for more information.

    + +
    exec_missing

    Deprecated.

    + +
    logfile

    An optional filename or connection object to where logging information will be written. To log to the console, use stderr() or stdout().

    +
    @@ -115,7 +132,7 @@ information will be written. To log to the console, use -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/domains.html b/reference/domains.html index fe27d6c85..cdab22d09 100644 --- a/reference/domains.html +++ b/reference/domains.html @@ -73,13 +73,20 @@ them ends) and error handling.

    domain

    A valid domain object (for example, a Shiny session), or NULL

    + +
    expr

    An expression to evaluate under domain

    + +
    callback

    A callback function to be invoked

    + +
    failIfNull

    If TRUE then an error is given if the domain is NULL

    +

    Details

    @@ -112,7 +119,7 @@ never be invoked.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/downloadButton.html b/reference/downloadButton.html index d26429b6d..6c0311b8e 100644 --- a/reference/downloadButton.html +++ b/reference/downloadButton.html @@ -75,14 +75,23 @@ function.

    outputId

    The name of the output slot that the downloadHandler is assigned to.

    + +
    label

    The label that should appear on the button.

    + +
    class

    Additional CSS classes to apply to the tag, if any.

    + +
    ...

    Other arguments to pass to the container tag function.

    + +
    icon

    An icon() to appear on the button. Default is icon("download").

    +

    See also

    @@ -127,7 +136,7 @@ is assigned to.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/downloadHandler.html b/reference/downloadHandler.html index 1862af4dc..ebf961683 100644 --- a/reference/downloadHandler.html +++ b/reference/downloadHandler.html @@ -75,21 +75,28 @@ download available.

    user's web browser should default to when downloading the file; or a function that returns such a string. (Reactive values and functions may be used from this function.)

    + +
    content

    A function that takes a single argument file that is a file path (string) of a nonexistent temp file, and writes the content to that file path. (Reactive values and functions may be used from this function.)

    + +
    contentType

    A string of the download's content type, for example "text/csv" or "image/png". If NULL, the content type will be guessed based on the filename extension, or application/octet-stream if the extension is unknown.

    + +
    outputArgs

    A list of arguments to be passed through to the implicit call to downloadButton() when downloadHandler is used in an interactive R Markdown document.

    +
    @@ -131,7 +138,7 @@ in an interactive R Markdown document.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/enableBookmarking.html b/reference/enableBookmarking.html index 79fc1ada1..08f010b8c 100644 --- a/reference/enableBookmarking.html +++ b/reference/enableBookmarking.html @@ -82,6 +82,7 @@ when the bookmarked state requires storing files.

    Either "url", which encodes all of the relevant values in a URL, "server", which saves to disk on the server, or "disable", which disables any previously-enabled bookmarking.

    +

    Details

    @@ -294,7 +295,7 @@ restored.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/exportTestValues.html b/reference/exportTestValues.html index e983b40f1..a3fb4f702 100644 --- a/reference/exportTestValues.html +++ b/reference/exportTestValues.html @@ -68,12 +68,19 @@ event occurs. These events are triggered by accessing a snapshot URL.

    ...

    Named arguments that are quoted or unquoted expressions that will be captured and evaluated when snapshot URL is visited.

    + +
    quoted_

    Are the expression quoted? Default is FALSE.

    + +
    env_

    The environment in which the expression should be evaluated.

    + +
    session_

    A Shiny session object.

    +

    Details

    @@ -138,7 +145,7 @@ global option shiny.testmode to TRUE.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/exprToFunction.html b/reference/exprToFunction.html index 385912a87..86c749f6e 100644 --- a/reference/exprToFunction.html +++ b/reference/exprToFunction.html @@ -64,11 +64,16 @@ debugging experience (Shiny 0.8.0). If the expr and quotedArguments
    expr

    A quoted or unquoted expression, or a quosure.

    + +
    env

    The desired environment for the function. Defaults to the calling environment two steps back.

    + +
    quoted

    Is the expression quoted?

    +

    Details

    @@ -91,7 +96,7 @@ calling environment two steps back.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/fileInput.html b/reference/fileInput.html index 31c407de9..d7c7c9cfa 100644 --- a/reference/fileInput.html +++ b/reference/fileInput.html @@ -69,12 +69,18 @@

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    multiple

    Whether the user should be allowed to select and upload multiple files at once. Does not work on older browsers, including Internet Explorer 9 and earlier.

    + +
    accept

    A character vector of "unique file type specifiers" which gives the browser a hint as to the type of file the server expects. @@ -84,14 +90,22 @@ Many browsers use this prevent the user from selecting an invalid file.

  • One of audio/*, video/*, or image/* meaning any audio, video, or image type, respectively.

    • + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    buttonLabel

    The label used on the button. Can be text or an HTML tag object.

    + +
    placeholder

    The text to show before a file has been uploaded.

    + +
    capture

    What source to use for capturing image, audio or video data. This attribute facilitates user access to a device's media capture @@ -103,6 +117,7 @@ camera and/or microphone should be used.

    By default on most phones, this will accept still photos or video. For still photos only, also use accept="image/*". For video only, use accept="video/*".

    +

    Details

    @@ -199,7 +214,7 @@ operation.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/fillPage.html b/reference/fillPage.html index a4c3a8fac..5398dcea6 100644 --- a/reference/fillPage.html +++ b/reference/fillPage.html @@ -69,6 +69,8 @@ available area of the browser window.

    Arguments

    ...

    Elements to include within the page.

    + +
    padding

    Padding to use for the body. This can be a numeric vector (which will be interpreted as pixels) or a character vector with valid CSS @@ -78,11 +80,17 @@ for the top and bottom, while the second value will be used for left and right. If three, then the first will be used for top, the second will be left and right, and the third will be bottom. If four, then the values will be interpreted as top, right, bottom, and left respectively.

    + +
    title

    The title to use for the browser window/tab (it will not be shown in the document).

    + +
    bootstrap

    If TRUE, load the Bootstrap CSS library.

    + +
    theme

    One of the following:

    • NULL (the default), which implies a "stock" build of Bootstrap 3.

    • A bslib::bs_theme() object. This can be used to replace a stock @@ -90,10 +98,13 @@ build of Bootstrap 3 with a customized version of Bootstrap 3 or higher.

      • A character string pointing to an alternative Bootstrap stylesheet (normally a css file within the www directory, e.g. www/bootstrap.css).

    + +
    lang

    ISO 639-1 language code for the HTML page, such as "en" or "ko". This will be used as the lang in the <html> tag, as in <html lang="en">. The default (NULL) results in an empty string.

    +

    Details

    @@ -189,7 +200,7 @@ package.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/fillRow.html b/reference/fillRow.html index 89ac4a40f..f4ebd2969 100644 --- a/reference/fillRow.html +++ b/reference/fillRow.html @@ -74,6 +74,8 @@ occupy a single cell. (To put multiple items in a single cell, you can use tagList() or div() to combine them.) Named arguments will be used as attributes on the div element that encapsulates the row/column.

    + +
    flex

    Determines how space should be distributed to the cells. Can be a single value like 1 or 2 to evenly distribute the available @@ -81,12 +83,15 @@ space; or use a vector of numbers to specify the proportions. For example, flex = c(2, 3) would cause the space to be split 40%/60% between two cells. NA values will cause the corresponding cell to be sized according to its contents (without growing or shrinking).

    + +
    width, height

    The total amount of width and height to use for the entire row/column. For the default height of "100%" to be effective, the parent must be fillPage, another fillRow/fillCol, or some other HTML element whose height is not determined by the height of its contents.

    +

    Details

    @@ -139,7 +144,7 @@ the size of their contents, as is usually the case in HTML).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/fixedPage.html b/reference/fixedPage.html index 7aa9cf345..d66ea69f4 100644 --- a/reference/fixedPage.html +++ b/reference/fixedPage.html @@ -74,8 +74,12 @@ displays respectively.

    Arguments

    ...

    Elements to include within the container

    + +
    title

    The browser window title (defaults to the host URL of the page)

    + +
    theme

    One of the following:

    • NULL (the default), which implies a "stock" build of Bootstrap 3.

    • A bslib::bs_theme() object. This can be used to replace a stock @@ -83,14 +87,19 @@ build of Bootstrap 3 with a customized version of Bootstrap 3 or higher.

      • A character string pointing to an alternative Bootstrap stylesheet (normally a css file within the www directory, e.g. www/bootstrap.css).

    + +
    lang

    ISO 639-1 language code for the HTML page, such as "en" or "ko". This will be used as the lang in the <html> tag, as in <html lang="en">. The default (NULL) results in an empty string.

    +

    Value

    -

    A UI definition that can be passed to the shinyUI function.

    + + +

    A UI definition that can be passed to the shinyUI function.

    Details

    @@ -152,7 +161,7 @@ pages.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/flowLayout.html b/reference/flowLayout.html index e19312f9c..d02408688 100644 --- a/reference/flowLayout.html +++ b/reference/flowLayout.html @@ -67,9 +67,12 @@ well with elements that have a percentage-based width (e.g.
    ...

    Unnamed arguments will become child elements of the layout. Named arguments will become HTML attributes on the outermost tag.

    + +
    cellArgs

    Any additional attributes that should be used for each cell of the layout.

    +

    See also

    @@ -109,7 +112,7 @@ of the layout.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/fluidPage.html b/reference/fluidPage.html index 476d1db0c..2409b4bf7 100644 --- a/reference/fluidPage.html +++ b/reference/fluidPage.html @@ -72,9 +72,13 @@ components in realtime to fill all available browser width.

    Arguments

    ...

    Elements to include within the page

    + +
    title

    The browser window title (defaults to the host URL of the page). Can also be set as a side effect of the titlePanel() function.

    + +
    theme

    One of the following:

    • NULL (the default), which implies a "stock" build of Bootstrap 3.

    • A bslib::bs_theme() object. This can be used to replace a stock @@ -82,14 +86,19 @@ build of Bootstrap 3 with a customized version of Bootstrap 3 or higher.

      • A character string pointing to an alternative Bootstrap stylesheet (normally a css file within the www directory, e.g. www/bootstrap.css).

    + +
    lang

    ISO 639-1 language code for the HTML page, such as "en" or "ko". This will be used as the lang in the <html> tag, as in <html lang="en">. The default (NULL) results in an empty string.

    +

    Value

    -

    A UI definition that can be passed to the shinyUI function.

    + + +

    A UI definition that can be passed to the shinyUI function.

    Details

    @@ -185,7 +194,7 @@ pages.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/freezeReactiveValue.html b/reference/freezeReactiveValue.html index 8a6c1dd4b..743621d2a 100644 --- a/reference/freezeReactiveValue.html +++ b/reference/freezeReactiveValue.html @@ -82,8 +82,11 @@ If this affects your app, please let us know by leaving a comment on

    For freezeReactiveValue, a reactiveValues() object (like input); for freezeReactiveVal, a reactiveVal() object.

    + +
    name

    The name of a value in the reactiveValues() object.

    +

    See also

    @@ -140,7 +143,7 @@ object (like input); for freezeReactiveVal, a
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/getCurrentOutputInfo.html b/reference/getCurrentOutputInfo.html index 689e7e4a0..a6ccbc7d5 100644 --- a/reference/getCurrentOutputInfo.html +++ b/reference/getCurrentOutputInfo.html @@ -62,10 +62,13 @@ and in some cases, relevant sizing and styling information.

    Arguments

    session

    The current Shiny session.

    +

    Value

    -

    NULL if called outside of an output context; otherwise, + + +

    NULL if called outside of an output context; otherwise, a list which includes:

    • The name of the output (reported for any output).

    • If the output is a plotOutput() or imageOutput(), then:

      • height: a reactive expression which returns the height in pixels.

      • width: a reactive expression which returns the width in pixels.

        • @@ -133,7 +136,7 @@ a list which includes:

        • The name of the output (report

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/getCurrentTheme.html b/reference/getCurrentTheme.html index f26a6b6ee..bcb405cca 100644 --- a/reference/getCurrentTheme.html +++ b/reference/getCurrentTheme.html @@ -60,8 +60,13 @@ styling based on the bootstrapLib()

    Value

    -

    If called at render-time (i.e., inside a htmltools::tagFunction()), -and bootstrapLib()'s theme has been set to a bslib::bs_theme()object, then this returns the theme. Otherwise, this returns NULL.

    + + +

    If called at render-time (i.e., inside a htmltools::tagFunction()), +and bootstrapLib()'s theme has been set to a bslib::bs_theme()

    + + +

    object, then this returns the theme. Otherwise, this returns NULL.

    See also

    @@ -80,7 +85,7 @@ and bootstrapLib()'s theme
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/getQueryString.html b/reference/getQueryString.html index e6e486408..9fbf0843e 100644 --- a/reference/getQueryString.html +++ b/reference/getQueryString.html @@ -64,10 +64,13 @@ component from the app's URL.

    Arguments

    session

    A Shiny session object.

    +

    Value

    -

    For getQueryString, a named list. For example, the query + + +

    For getQueryString, a named list. For example, the query string ?param1=value1&param2=value2 becomes list(param1 = value1, param2 = value2). For getUrlHash, a character vector with the hash (including the leading # symbol).

    @@ -157,7 +160,7 @@ to worry about this.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/headerPanel.html b/reference/headerPanel.html index f7a8478b3..20fed3347 100644 --- a/reference/headerPanel.html +++ b/reference/headerPanel.html @@ -60,13 +60,20 @@

    Arguments

    title

    An application title to display

    + +
    windowTitle

    The title that should be displayed by the browser window. Useful if title is not a string.

    +

    Value

    -

    A headerPanel that can be passed to pageWithSidebar

    + + +

    A headerPanel that can be passed to pageWithSidebar

    + +
    @@ -81,7 +88,7 @@ Useful if title is not a string.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/helpText.html b/reference/helpText.html index 68e9dd50e..0dea354b3 100644 --- a/reference/helpText.html +++ b/reference/helpText.html @@ -62,10 +62,13 @@ explanation or context.

    Arguments

    ...

    One or more help text strings (or other inline HTML elements)

    +

    Value

    -

    A help text element that can be added to a UI definition.

    + + +

    A help text element that can be added to a UI definition.

    @@ -92,7 +95,7 @@ explanation or context.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/htmlOutput.html b/reference/htmlOutput.html index 295ef7206..c062804a8 100644 --- a/reference/htmlOutput.html +++ b/reference/htmlOutput.html @@ -71,18 +71,27 @@ contain HTML content which should not be escaped.

    Arguments

    outputId

    output variable to read the value from

    + +
    inline

    use an inline (span()) or block container (div()) for the output

    + +
    container

    a function to generate an HTML element to contain the text

    + +
    ...

    Other arguments to pass to the container tag function. This is useful for providing additional classes for the tag.

    +

    Value

    -

    An HTML output element that can be included in a panel

    + + +

    An HTML output element that can be included in a panel

    Details

    @@ -116,7 +125,7 @@ side. It is currently just an alias for htmlOutput.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/httpResponse.html b/reference/httpResponse.html index d6236f67e..32a0d020a 100644 --- a/reference/httpResponse.html +++ b/reference/httpResponse.html @@ -65,15 +65,22 @@

    Arguments

    status

    HTTP status code for the response.

    + +
    content_type

    The value for the Content-Type header.

    + +
    content

    The body of the response, given as a single-element character vector (will be encoded as UTF-8) or a raw vector.

    + +
    headers

    A named list of additional headers to include. Do not include Content-Length (as it is automatically calculated) or Content-Type (the content_type argument is used instead).

    +
    @@ -113,7 +120,7 @@ vector (will be encoded as UTF-8) or a raw vector.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/icon.html b/reference/icon.html index 50991cc2f..fa65ba59b 100644 --- a/reference/icon.html +++ b/reference/icon.html @@ -68,18 +68,27 @@ of a button, and/or used with tabPanel()"fa-calendar"     icon should be referred to as "calendar"). A name of NULL may also be provided to get a raw <i> tag with no library attached to it.

    + +
    class

    Additional classes to customize the style of an icon (see the usage examples for details on supported styles).

    + +
    lib

    The icon library to use. Either "font-awesome" or "glyphicon".

    + +
    ...

    Arguments passed to the <i> tag of htmltools::tags.

    +

    Value

    -

    An <i> (icon) HTML tag.

    + + +

    An <i> (icon) HTML tag.

    See also

    @@ -111,21 +120,21 @@ and #> <div class="navbar-header"> #> <span class="navbar-brand">App Title</span> #> </div> -#> <ul class="nav navbar-nav" data-tabsetid="7753"> +#> <ul class="nav navbar-nav" data-tabsetid="4848"> #> <li class="active"> -#> <a href="#tab-7753-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot"> +#> <a href="#tab-4848-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot"> #> <i aria-label="bar-chart-o icon" class="fa fa-bar-chart-o fa-fw" role="presentation"></i> #> Plot #> </a> #> </li> #> <li> -#> <a href="#tab-7753-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary"> +#> <a href="#tab-4848-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary"> #> <i aria-label="list-alt icon" class="fa fa-list-alt fa-fw" role="presentation"></i> #> Summary #> </a> #> </li> #> <li> -#> <a href="#tab-7753-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table"> +#> <a href="#tab-4848-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table"> #> <i aria-label="table icon" class="fa fa-table fa-fw" role="presentation"></i> #> Table #> </a> @@ -134,10 +143,10 @@ and #> </div> #> </nav> #> <div class="container-fluid"> -#> <div class="tab-content" data-tabsetid="7753"> -#> <div class="tab-pane active" data-icon-class="fa fa-bar-chart-o fa-fw" data-value="Plot" id="tab-7753-1"></div> -#> <div class="tab-pane" data-value="Summary" data-icon-class="fa fa-list-alt fa-fw" id="tab-7753-2"></div> -#> <div class="tab-pane" data-value="Table" data-icon-class="fa fa-table fa-fw" id="tab-7753-3"></div> +#> <div class="tab-content" data-tabsetid="4848"> +#> <div class="tab-pane active" data-icon-class="fa fa-bar-chart-o fa-fw" data-value="Plot" id="tab-4848-1"></div> +#> <div class="tab-pane" data-value="Summary" data-icon-class="fa fa-list-alt fa-fw" id="tab-4848-2"></div> +#> <div class="tab-pane" data-value="Table" data-icon-class="fa fa-table fa-fw" id="tab-4848-3"></div> #> </div> #> </div>
    @@ -154,7 +163,7 @@ and -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/index.html b/reference/index.html index bacad7de7..fb69ed353 100644 --- a/reference/index.html +++ b/reference/index.html @@ -647,7 +647,7 @@
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/inputPanel.html b/reference/inputPanel.html index a8987cb8a..b77e298b0 100644 --- a/reference/inputPanel.html +++ b/reference/inputPanel.html @@ -62,6 +62,7 @@ suitable for wrapping inputs.

    Arguments

    ...

    Input controls or other HTML elements.

    +
    @@ -76,7 +77,7 @@ suitable for wrapping inputs.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/insertTab.html b/reference/insertTab.html index 2c3cfb76e..543743340 100644 --- a/reference/insertTab.html +++ b/reference/insertTab.html @@ -91,22 +91,34 @@ navlistPanel() or navbarPage()."><

    The id of the tabsetPanel (or navlistPanel or navbarPage) into which tab will be inserted/removed.

    + +
    tab

    The item to be added (must be created with tabPanel, or with navbarMenu).

    + +
    target

    If inserting: the value of an existing tabPanel, next to which tab will be added. If removing: the value of the tabPanel that you want to remove. See Details if you want to insert next to/remove an entire navbarMenu instead.

    + +
    position

    Should tab be added before or after the target tab?

    + +
    select

    Should tab be selected upon being inserted?

    + +
    session

    The shiny session within which to call this function.

    + +
    menuName

    This argument should only be used when you want to prepend (or append) tab to the beginning (or end) of an @@ -119,6 +131,7 @@ of the title argument). Note that you still need to set the navbarPage is. If menuName is left as NULL, tab will be prepended (or appended) to whatever inputId is.

    +

    Details

    @@ -226,7 +239,7 @@ this is equal to the value of the title argument).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/insertUI.html b/reference/insertUI.html index 3df7cc214..9d61cab79 100644 --- a/reference/insertUI.html +++ b/reference/insertUI.html @@ -98,6 +98,8 @@ note that many of these are wrapped in <div>s, so you may nee somewhat complex selector --- see the Examples below. (Alternatively, you could also wrap the inputs/outputs that you want to be able to remove easily in a <div> with an id.)

    + +
    where

    Where your UI object should go relative to the selector:

    beforeBegin

    Before the selector element itself

    @@ -115,6 +117,8 @@ last child (default)

    Adapted from https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentHTML.

    + +
    ui

    The UI object you want to insert. This can be anything that you usually put inside your apps's ui function. If you're inserting @@ -123,17 +127,24 @@ multiple elements in one call, make sure to wrap them in either a advantage that you can give it an id to make it easier to reference or remove it later on). If you want to insert raw html, use ui = HTML().

    + +
    multiple

    In case your selector matches more than one element, multiple determines whether Shiny should insert the UI object relative to all matched elements or just relative to the first matched element (default).

    + +
    immediate

    Whether the UI object should be immediately inserted or removed, or whether Shiny should wait until all outputs have been updated and all observers have been run (default).

    + +
    session

    The shiny session. Advanced use only.

    +

    Details

    @@ -200,7 +211,7 @@ through a jQuery selector can be removed through this function.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/invalidateLater.html b/reference/invalidateLater.html index ab2f70716..89ffeff9a 100644 --- a/reference/invalidateLater.html +++ b/reference/invalidateLater.html @@ -63,11 +63,14 @@ of milliseconds.

    millis

    Approximate milliseconds to wait before invalidating the current reactive context.

    + +
    session

    A session object. This is needed to cancel any scheduled invalidations after a user has ended the session. If NULL, then this invalidation will not be tied to any session, and so it will still occur.

    +

    Details

    @@ -130,7 +133,7 @@ possible to stop this cycle by adding conditional logic that prevents the
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/is.reactivevalues.html b/reference/is.reactivevalues.html index 8fa8c9d9a..3cccb87fd 100644 --- a/reference/is.reactivevalues.html +++ b/reference/is.reactivevalues.html @@ -60,6 +60,7 @@

    Arguments

    x

    The object to test.

    +

    See also

    @@ -78,7 +79,7 @@
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/isRunning.html b/reference/isRunning.html index cbf350d52..4a24d12f0 100644 --- a/reference/isRunning.html +++ b/reference/isRunning.html @@ -58,7 +58,9 @@

    Value

    -

    TRUE if a Shiny application is currently running. Otherwise, + + +

    TRUE if a Shiny application is currently running. Otherwise, FALSE.

    @@ -74,7 +76,7 @@
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/isTruthy.html b/reference/isTruthy.html index ad836cd26..a9fbbd7b7 100644 --- a/reference/isTruthy.html +++ b/reference/isTruthy.html @@ -70,6 +70,7 @@ clicked?".

    Arguments

    x

    An expression whose truthiness value we want to determine

    +

    Details

    @@ -99,7 +100,7 @@ a value of "", so that is considered a falsy value.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/isolate.html b/reference/isolate.html index 725711ffa..855bdcd9c 100644 --- a/reference/isolate.html +++ b/reference/isolate.html @@ -64,6 +64,7 @@ re-evaluated when they change.

    Arguments

    expr

    An expression that can access reactive values or expressions.

    +

    Details

    @@ -143,7 +144,7 @@ calls to the reactive expression with isolate().

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/knitr_methods.html b/reference/knitr_methods.html index 00c9954d7..70176b7b1 100644 --- a/reference/knitr_methods.html +++ b/reference/knitr_methods.html @@ -66,10 +66,15 @@ themselves in knitr/rmarkdown documents.

    Arguments

    x

    Object to knit_print

    + +
    ...

    Additional knit_print arguments

    + +
    inline

    Whether the object is printed inline.

    +
    @@ -84,7 +89,7 @@ themselves in knitr/rmarkdown documents.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/loadSupport.html b/reference/loadSupport.html index f33c3e489..389014e0d 100644 --- a/reference/loadSupport.html +++ b/reference/loadSupport.html @@ -70,12 +70,17 @@ adjacent to the app.R/server.R/ui.R files

    The application directory. If appDir is NULL or not supplied, the nearest enclosing directory that is a Shiny app, starting with the current directory, is used.

    + +
    renv

    The environment in which the files in the R/ directory should be evaluated.

    + +
    globalrenv

    The environment in which global.R should be evaluated. If NULL, global.R will not be evaluated at all.

    +

    Details

    @@ -103,7 +108,7 @@ breaking it, so after running your application, you should unset option with
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/makeReactiveBinding.html b/reference/makeReactiveBinding.html index 55a15c194..5ed96b4f5 100644 --- a/reference/makeReactiveBinding.html +++ b/reference/makeReactiveBinding.html @@ -66,12 +66,17 @@ reactive variable (or NULL if the variable did not exist).

    Arguments

    symbol

    Name of variable to make reactive, as a string.

    + +
    env

    Environment in which to create binding. Expert use only.

    +

    Value

    -

    None.

    + + +

    None.

    @@ -102,7 +107,7 @@ reactive variable (or NULL if the variable did not exist).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/markOutputAttrs.html b/reference/markOutputAttrs.html index 1381bf57c..f6dc79655 100644 --- a/reference/markOutputAttrs.html +++ b/reference/markOutputAttrs.html @@ -61,11 +61,16 @@
    renderFunc

    A function that is suitable for assigning to a Shiny output slot.

    + +
    snapshotExclude

    If TRUE, exclude the output from test snapshots.

    + +
    snapshotPreprocess

    A function for preprocessing the value before taking a test snapshot.

    +
    @@ -80,7 +85,7 @@ taking a test snapshot.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/markRenderFunction.html b/reference/markRenderFunction.html index d0fb3975b..7ce8f4061 100644 --- a/reference/markRenderFunction.html +++ b/reference/markRenderFunction.html @@ -70,9 +70,13 @@ support async execution. (Shiny 1.1.0)

    uiFunc

    A function that renders Shiny UI. Must take a single argument: an output ID.

    + +
    renderFunc

    A function that is suitable for assigning to a Shiny output slot.

    + +
    outputArgs

    A list of arguments to pass to the uiFunc. Render functions should include outputArgs = list() in their own parameter list, @@ -80,18 +84,24 @@ and pass through the value to markRenderFunction, to allow app auth customize outputs. (Currently, this is only supported for dynamically generated UIs, such as those created by Shiny code snippets embedded in R Markdown documents).

    + +
    cacheHint

    One of "auto", FALSE, or some other information to identify this instance for caching using bindCache(). If "auto", it will try to automatically infer caching information. If FALSE, do not allow caching for the object. Some render functions (such as renderPlot) contain internal state that makes them unsuitable for caching.

    + +
    cacheWriteHook

    Used if the render function is passed to bindCache(). This is an optional callback function to invoke before saving the value from the render function to the cache. This function must accept one argument, the value returned from renderFunc, and should return the value to store in the cache.

    + +
    cacheReadHook

    Used if the render function is passed to bindCache(). This is an optional callback function to invoke after reading a value from @@ -100,10 +110,13 @@ argument, the value retrieved from the cache. This can be useful when some side effect needs to occur for a render function to behave correctly. For example, some render functions call createWebDependency() so that Shiny is able to serve JS and CSS resources.

    +

    Value

    -

    The renderFunc function, with annotations.

    + + +

    The renderFunc function, with annotations.

    Details

    @@ -137,7 +150,7 @@ interface. There may be cases where markRenderFunction() must be us
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/markdown.html b/reference/markdown.html index 9429962ee..acac23295 100644 --- a/reference/markdown.html +++ b/reference/markdown.html @@ -66,19 +66,28 @@ HTML that may be included in Shiny UIs.

    A character vector of Markdown source to convert to HTML. If the vector has more than one element, a single-element character vector of concatenated HTML is returned.

    + +
    extensions

    Enable Github syntax extensions; defaults to TRUE.

    + +
    .noWS

    Character vector used to omit some of the whitespace that would normally be written around generated HTML. Valid options include before, after, and outside (equivalent to before and end).

    + +
    ...

    Additional arguments to pass to commonmark::markdown_html(). These arguments are dynamic.

    +

    Value

    -

    a character vector marked as HTML.

    + + +

    a character vector marked as HTML.

    Details

    @@ -126,7 +135,7 @@ arguments to markdown() are passed as arguments to markdown_h
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/maskReactiveContext.html b/reference/maskReactiveContext.html index adc437bb1..8ff3c2d29 100644 --- a/reference/maskReactiveContext.html +++ b/reference/maskReactiveContext.html @@ -66,10 +66,13 @@ default, an error).

    Arguments

    expr

    An expression to evaluate.

    +

    Value

    -

    The value of expr.

    + + +

    The value of expr.

    See also

    @@ -88,7 +91,7 @@ default, an error).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/memoryCache.html b/reference/memoryCache.html index 4073073f3..64071d9a5 100644 --- a/reference/memoryCache.html +++ b/reference/memoryCache.html @@ -70,27 +70,40 @@

    Maximum size of the cache, in bytes. If the cache exceeds this size, cached objects will be removed according to the value of the evict. Use Inf for no size limit. The default is 1 gigabyte.

    + +
    max_age

    Maximum age of files in cache before they are evicted, in seconds. Use Inf for no age limit.

    + +
    max_n

    Maximum number of objects in the cache. If the number of objects exceeds this value, then cached objects will be removed according to the value of evict. Use Inf for no limit of number of items.

    + +
    evict

    The eviction policy to use to decide which objects are removed when a cache pruning occurs. Currently, "lru" and "fifo" are supported.

    + +
    missing

    A value to return when get(key) is called but the key is not present in the cache. The default is a key_missing() object. It is actually an expression that is evaluated each time there is a cache miss. See section Missing keys for more information.

    + +
    exec_missing

    Deprecated.

    + +
    logfile

    An optional filename or connection object to where logging information will be written. To log to the console, use stderr() or stdout().

    + @@ -105,7 +118,7 @@ information will be written. To log to the console, use -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/modalDialog.html b/reference/modalDialog.html index 9eddaa4ef..04ddc2a0d 100644 --- a/reference/modalDialog.html +++ b/reference/modalDialog.html @@ -79,27 +79,42 @@ typically used when customising the footer.

    Arguments

    ...

    UI elements for the body of the modal dialog box.

    + +
    title

    An optional title for the dialog.

    + +
    footer

    UI for footer. Use NULL for no footer.

    + +
    size

    One of "s" for small, "m" (the default) for medium, or "l" for large.

    + +
    easyClose

    If TRUE, the modal dialog can be dismissed by clicking outside the dialog box, or be pressing the Escape key. If FALSE (the default), the modal dialog can't be dismissed in those ways; instead it must be dismissed by clicking on a modalButton(), or from a call to removeModal() on the server.

    + +
    fade

    If FALSE, the modal dialog will have no fade-in animation (it will simply appear rather than fade in to view).

    + +
    label

    The contents of the button or link--usually a text label, but you could also use any other HTML, like an image.

    + +
    icon

    An optional icon() to appear on the button.

    +
    @@ -214,7 +229,7 @@ you could also use any other HTML, like an image.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/moduleServer.html b/reference/moduleServer.html index 56c835257..34ca6849d 100644 --- a/reference/moduleServer.html +++ b/reference/moduleServer.html @@ -67,15 +67,22 @@ modules are easier to reuse and easier to reason about. See the article at
    id

    An ID string that corresponds with the ID used to call the module's UI function.

    + +
    module

    A Shiny module server function.

    + +
    session

    Session from which to make a child scope (the default should almost always be used).

    +

    Value

    -

    The return value, if any, from executing the module server function

    + + +

    The return value, if any, from executing the module server function

    Details

    @@ -175,7 +182,7 @@ to understand, and modules created with moduleServer can be tested
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/navbarPage.html b/reference/navbarPage.html index c66ac1870..18327b9b3 100644 --- a/reference/navbarPage.html +++ b/reference/navbarPage.html @@ -78,20 +78,28 @@ toggle a set of tabPanel() elements.

    Arguments
    title

    The title to display in the navbar

    + +
    ...

    tabPanel() elements to include in the page. The navbarMenu function also accepts strings, which will be used as menu section headers. If the string is a set of dashes like "----" a horizontal separator will be displayed in the menu.

    + +
    id

    If provided, you can use input$id in your server logic to determine which of the current tabs is active. The value will correspond to the value argument that is passed to tabPanel().

    + +
    selected

    The value (or, if none was supplied, the title) of the tab that should be selected by default. If NULL, the first tab will be selected.

    + +
    position

    Determines whether the navbar should be displayed at the top of the page with normal scrolling behavior ("static-top"), pinned at @@ -100,22 +108,34 @@ the top ("fixed-top"), or pinned at the bottom "fixed-bottom" will cause the navbar to overlay your body content, unless you add padding, e.g.: tags$style(type="text/css", "body {padding-top: 70px;}")

    + +
    header

    Tag or list of tags to display as a common header above all tabPanels.

    + +
    footer

    Tag or list of tags to display as a common footer below all tabPanels

    + +
    inverse

    TRUE to use a dark background and light text for the navigation bar

    + +
    collapsible

    TRUE to automatically collapse the navigation elements into a menu when the width of the browser is less than 940 pixels (useful for viewing on smaller touchscreen device)

    + +
    fluid

    TRUE to use a fluid layout. FALSE to use a fixed layout.

    + +
    theme

    One of the following:

    • NULL (the default), which implies a "stock" build of Bootstrap 3.

    • A bslib::bs_theme() object. This can be used to replace a stock @@ -123,25 +143,36 @@ build of Bootstrap 3 with a customized version of Bootstrap 3 or higher.

      • A character string pointing to an alternative Bootstrap stylesheet (normally a css file within the www directory, e.g. www/bootstrap.css).

    + +
    windowTitle

    the browser window title (as a character string). The default value, NA, means to use any character strings that appear in title (if none are found, the host URL of the page is displayed by default).

    + +
    lang

    ISO 639-1 language code for the HTML page, such as "en" or "ko". This will be used as the lang in the <html> tag, as in <html lang="en">. The default (NULL) results in an empty string.

    + +
    menuName

    A name that identifies this navbarMenu. This is needed if you want to insert/remove or show/hide an entire navbarMenu.

    + +
    icon

    Optional icon to appear on a navbarMenu tab.

    +

    Value

    -

    A UI definition that can be passed to the shinyUI function.

    + + +

    A UI definition that can be passed to the shinyUI function.

    Details

    @@ -176,24 +207,24 @@ example below).

    #> <div class="navbar-header"> #> <span class="navbar-brand">App Title</span> #> </div> -#> <ul class="nav navbar-nav" data-tabsetid="1343"> +#> <ul class="nav navbar-nav" data-tabsetid="6984"> #> <li class="active"> -#> <a href="#tab-1343-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot">Plot</a> +#> <a href="#tab-6984-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot">Plot</a> #> </li> #> <li> -#> <a href="#tab-1343-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary">Summary</a> +#> <a href="#tab-6984-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary">Summary</a> #> </li> #> <li> -#> <a href="#tab-1343-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table">Table</a> +#> <a href="#tab-6984-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table">Table</a> #> </li> #> </ul> #> </div> #> </nav> #> <div class="container-fluid"> -#> <div class="tab-content" data-tabsetid="1343"> -#> <div class="tab-pane active" data-value="Plot" id="tab-1343-1"></div> -#> <div class="tab-pane" data-value="Summary" id="tab-1343-2"></div> -#> <div class="tab-pane" data-value="Table" id="tab-1343-3"></div> +#> <div class="tab-content" data-tabsetid="6984"> +#> <div class="tab-pane active" data-value="Plot" id="tab-6984-1"></div> +#> <div class="tab-pane" data-value="Summary" id="tab-6984-2"></div> +#> <div class="tab-pane" data-value="Table" id="tab-6984-3"></div> #> </div> #> </div> @@ -211,23 +242,23 @@ example below).

    #> <div class="navbar-header"> #> <span class="navbar-brand">App Title</span> #> </div> -#> <ul class="nav navbar-nav" data-tabsetid="9821"> +#> <ul class="nav navbar-nav" data-tabsetid="1971"> #> <li class="active"> -#> <a href="#tab-9821-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot">Plot</a> +#> <a href="#tab-1971-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot">Plot</a> #> </li> #> <li class="dropdown"> #> <a href="#" class="dropdown-toggle" data-toggle="dropdown" data-bs-toggle="dropdown" data-value="More"> #> More #> <b class="caret"></b> #> </a> -#> <ul class="dropdown-menu" data-tabsetid="2901"> +#> <ul class="dropdown-menu" data-tabsetid="7811"> #> <li> -#> <a href="#tab-2901-1" data-toggle="tab" data-bs-toggle="tab" data-value="Summary">Summary</a> +#> <a href="#tab-7811-1" data-toggle="tab" data-bs-toggle="tab" data-value="Summary">Summary</a> #> </li> #> <li class="divider"></li> #> <li class="dropdown-header">Section header</li> #> <li> -#> <a href="#tab-2901-4" data-toggle="tab" data-bs-toggle="tab" data-value="Table">Table</a> +#> <a href="#tab-7811-4" data-toggle="tab" data-bs-toggle="tab" data-value="Table">Table</a> #> </li> #> </ul> #> </li> @@ -235,10 +266,10 @@ example below).

    #> </div> #> </nav> #> <div class="container-fluid"> -#> <div class="tab-content" data-tabsetid="9821"> -#> <div class="tab-pane active" data-value="Plot" id="tab-9821-1"></div> -#> <div class="tab-pane" data-value="Summary" id="tab-2901-1"></div> -#> <div class="tab-pane" data-value="Table" id="tab-2901-4"></div> +#> <div class="tab-content" data-tabsetid="1971"> +#> <div class="tab-pane active" data-value="Plot" id="tab-1971-1"></div> +#> <div class="tab-pane" data-value="Summary" id="tab-7811-1"></div> +#> <div class="tab-pane" data-value="Table" id="tab-7811-4"></div> #> </div> #> </div>
    @@ -255,7 +286,7 @@ example below).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/navlistPanel.html b/reference/navlistPanel.html index bcbe8d9fa..fda27ee42 100644 --- a/reference/navlistPanel.html +++ b/reference/navlistPanel.html @@ -71,30 +71,45 @@ which navigate to a set of tabPanels displayed to the right.

    Arguments

    ...

    tabPanel() elements to include in the navlist

    + +
    id

    If provided, you can use input$id in your server logic to determine which of the current navlist items is active. The value will correspond to the value argument that is passed to tabPanel().

    + +
    selected

    The value (or, if none was supplied, the title) of the navigation item that should be selected by default. If NULL, the first navigation will be selected.

    + +
    header

    Tag or list of tags to display as a common header above all tabPanels.

    + +
    footer

    Tag or list of tags to display as a common footer below all tabPanels

    + +
    well

    TRUE to place a well (gray rounded rectangle) around the navigation list.

    + +
    fluid

    TRUE to use fluid layout; FALSE to use fixed layout.

    + +
    widths

    Column widths of the navigation list and tabset content areas respectively.

    +

    Details

    @@ -127,24 +142,24 @@ doesn't support separators.

    #> <h2>Application Title</h2> #> <div class="row"> #> <div class="col-sm-4 well"> -#> <ul class="nav nav-pills nav-stacked" data-tabsetid="3404"> +#> <ul class="nav nav-pills nav-stacked" data-tabsetid="2544"> #> <li class="navbar-brand">Header</li> #> <li class="active"> -#> <a href="#tab-3404-2" data-toggle="tab" data-bs-toggle="tab" data-value="First">First</a> +#> <a href="#tab-2544-2" data-toggle="tab" data-bs-toggle="tab" data-value="First">First</a> #> </li> #> <li> -#> <a href="#tab-3404-3" data-toggle="tab" data-bs-toggle="tab" data-value="Second">Second</a> +#> <a href="#tab-2544-3" data-toggle="tab" data-bs-toggle="tab" data-value="Second">Second</a> #> </li> #> <li> -#> <a href="#tab-3404-4" data-toggle="tab" data-bs-toggle="tab" data-value="Third">Third</a> +#> <a href="#tab-2544-4" data-toggle="tab" data-bs-toggle="tab" data-value="Third">Third</a> #> </li> #> </ul> #> </div> #> <div class="col-sm-8"> -#> <div class="tab-content" data-tabsetid="3404"> -#> <div class="tab-pane active" data-value="First" id="tab-3404-2"></div> -#> <div class="tab-pane" data-value="Second" id="tab-3404-3"></div> -#> <div class="tab-pane" data-value="Third" id="tab-3404-4"></div> +#> <div class="tab-content" data-tabsetid="2544"> +#> <div class="tab-pane active" data-value="First" id="tab-2544-2"></div> +#> <div class="tab-pane" data-value="Second" id="tab-2544-3"></div> +#> <div class="tab-pane" data-value="Third" id="tab-2544-4"></div> #> </div> #> </div> #> </div> @@ -163,7 +178,7 @@ doesn't support separators.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/numericInput.html b/reference/numericInput.html index df35eba6b..a8317b9ec 100644 --- a/reference/numericInput.html +++ b/reference/numericInput.html @@ -68,23 +68,38 @@

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    value

    Initial value.

    + +
    min

    Minimum allowed value

    + +
    max

    Maximum allowed value

    + +
    step

    Interval to use when stepping between min and max

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    +

    Value

    -

    A numeric input control that can be added to a UI definition.

    + + +

    A numeric input control that can be added to a UI definition.

    Server value

    @@ -141,7 +156,7 @@ see
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/observe.html b/reference/observe.html index ab8539600..e14f8993d 100644 --- a/reference/observe.html +++ b/reference/observe.html @@ -72,41 +72,62 @@
    x

    An expression (quoted or unquoted). Any return value will be ignored.

    + +
    env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If x is a quosure and quoted is TRUE, then env is ignored.

    + +
    quoted

    If it is TRUE, then the quote()ed value of x will be used when x is evaluated. If x is a quosure and you would like to use its expression as a value for x, then you must set quoted to TRUE.

    + +
    ...

    Not used.

    + +
    label

    A label for the observer, useful for debugging.

    + +
    suspended

    If TRUE, start the observer in a suspended state. If FALSE (the default), start in a non-suspended state.

    + +
    priority

    An integer or numeric that controls the priority with which this observer should be executed. A higher value means higher priority: an observer with a higher priority value will execute before all observers with lower priority values. Positive, negative, and zero values are allowed.

    + +
    domain

    See domains.

    + +
    autoDestroy

    If TRUE (the default), the observer will be automatically destroyed when its domain (if any) ends.

    + +
    ..stacktraceon

    Advanced use only. For stack manipulation purposes; see stacktrace().

    +

    Value

    -

    An observer reference class object. This object has the following + + +

    An observer reference class object. This object has the following methods:

    suspend()

    Causes this observer to stop scheduling flushes (re-executions) in response to invalidations. If the observer was invalidated prior to @@ -195,7 +216,7 @@ session ends).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/observeEvent.html b/reference/observeEvent.html index 5d2b271a5..1f3eb37ac 100644 --- a/reference/observeEvent.html +++ b/reference/observeEvent.html @@ -101,80 +101,117 @@ renderText() and renderPlot()).'>< this can be a simple reactive value like input$click, a call to a reactive expression like dataset(), or even a complex expression inside curly braces

    + +
    handlerExpr

    The expression to call whenever eventExpr is invalidated. This should be a side-effect-producing action (the return value will be ignored). It will be executed within an isolate() scope.

    + +
    event.env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If eventExpr is a quosure and event.quoted is TRUE, then event.env is ignored.

    + +
    event.quoted

    If it is TRUE, then the quote()ed value of eventExpr will be used when eventExpr is evaluated. If eventExpr is a quosure and you would like to use its expression as a value for eventExpr, then you must set event.quoted to TRUE.

    + +
    handler.env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If handlerExpr is a quosure and handler.quoted is TRUE, then handler.env is ignored.

    + +
    handler.quoted

    If it is TRUE, then the quote()ed value of handlerExpr will be used when handlerExpr is evaluated. If handlerExpr is a quosure and you would like to use its expression as a value for handlerExpr, then you must set handler.quoted to TRUE.

    + +
    ...

    Currently not used.

    + +
    label

    A label for the observer or reactive, useful for debugging.

    + +
    suspended

    If TRUE, start the observer in a suspended state. If FALSE (the default), start in a non-suspended state.

    + +
    priority

    An integer or numeric that controls the priority with which this observer should be executed. An observer with a given priority level will always execute sooner than all observers with a lower priority level. Positive, negative, and zero values are allowed.

    + +
    domain

    See domains.

    + +
    autoDestroy

    If TRUE (the default), the observer will be automatically destroyed when its domain (if any) ends.

    + +
    ignoreNULL

    Whether the action should be triggered (or value calculated, in the case of eventReactive) when the input is NULL. See Details.

    + +
    ignoreInit

    If TRUE, then, when this observeEvent is first created/initialized, ignore the handlerExpr (the second argument), whether it is otherwise supposed to run or not. The default is FALSE. See Details.

    + +
    once

    Whether this observeEvent should be immediately destroyed after the first time that the code in handlerExpr is run. This pattern is useful when you want to subscribe to a event that should only happen once.

    + +
    valueExpr

    The expression that produces the return value of the eventReactive. It will be executed within an isolate() scope.

    + +
    value.env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If valueExpr is a quosure and value.quoted is TRUE, then value.env is ignored.

    + +
    value.quoted

    If it is TRUE, then the quote()ed value of valueExpr will be used when valueExpr is evaluated. If valueExpr is a quosure and you would like to use its expression as a value for valueExpr, then you must set value.quoted to TRUE.

    +

    Value

    -

    observeEvent returns an observer reference class object (see + + +

    observeEvent returns an observer reference class object (see observe()). eventReactive returns a reactive expression object (see reactive()).

    @@ -361,7 +398,7 @@ created (because ignoreInit = TRUE). After that,
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/onBookmark.html b/reference/onBookmark.html index 5152dcc19..ae121116a 100644 --- a/reference/onBookmark.html +++ b/reference/onBookmark.html @@ -97,8 +97,11 @@ browser.

    Arguments

    fun

    A callback function which takes one argument.

    + +
    session

    A shiny session object.

    +

    Details

    @@ -281,7 +284,7 @@ module's inputs and values.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/onFlush.html b/reference/onFlush.html index e5aa9c179..9b35922d7 100644 --- a/reference/onFlush.html +++ b/reference/onFlush.html @@ -72,12 +72,17 @@ registers a function to be called after the client has disconnected.

    Arguments

    fun

    A callback function.

    + +
    once

    Should the function be run once, and then cleared, or should it re-run each time the event occurs. (Only for onFlush and onFlushed.)

    + +
    session

    A shiny session object.

    +

    Details

    @@ -103,7 +108,7 @@ invoked when the application exits, or when a session ends.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/onStop.html b/reference/onStop.html index a73c18613..c1bb5b2c6 100644 --- a/reference/onStop.html +++ b/reference/onStop.html @@ -64,6 +64,8 @@ session ends (when a client disconnects).

    Arguments

    fun

    A function that will be called after the app has finished running.

    + +
    session

    A scope for when the callback will run. If onStop is called from within the server function, this will default to the current @@ -72,10 +74,13 @@ session, and the callback will be invoked when the current session ends. If be invoked with the application exits. If NULL, it is the same as calling onStop outside of the server function, and the callback will be invoked when the application exits.

    +

    Value

    -

    A function which, if invoked, will cancel the callback.

    + + +

    A function which, if invoked, will cancel the callback.

    See also

    @@ -149,7 +154,7 @@ the session level only.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/outputOptions.html b/reference/outputOptions.html index 713fb30d4..7400e27cf 100644 --- a/reference/outputOptions.html +++ b/reference/outputOptions.html @@ -73,10 +73,15 @@ with higher priority values will execute before those with lower values.

    Arguments
    x

    A shinyoutput object (typically output).

    + +
    name

    The name of an output observer in the shinyoutput object.

    + +
    ...

    Options to set for the output observer.

    +
    @@ -109,7 +114,7 @@ with higher priority values will execute before those with lower values.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/pageWithSidebar.html b/reference/pageWithSidebar.html index 59c6ea22e..b853c3748 100644 --- a/reference/pageWithSidebar.html +++ b/reference/pageWithSidebar.html @@ -60,14 +60,21 @@

    Arguments

    headerPanel

    The headerPanel with the application title

    + +
    sidebarPanel

    The sidebarPanel containing input controls

    + +
    mainPanel

    The mainPanel containing outputs

    +

    Value

    -

    A UI definition that can be passed to the shinyUI function

    + + +

    A UI definition that can be passed to the shinyUI function

    @@ -82,7 +89,7 @@
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/parseQueryString.html b/reference/parseQueryString.html index 6ca4f8bf1..15002694f 100644 --- a/reference/parseQueryString.html +++ b/reference/parseQueryString.html @@ -60,6 +60,8 @@

    Arguments

    str

    The query string. It can have a leading "?" or not.

    + +
    nested

    Whether to parse the query string of as a nested list when it contains pairs of square brackets []. For example, the query @@ -67,6 +69,7 @@ contains pairs of square brackets []. For example, the query list(i1 = list(j1 = 'x')), b = list(i1 = list(j1 = 'y'), i2 = list(j1 = 'z'))) when nested = TRUE, and list(`a[i1][j1]` = 'x', `b[i1][j1]` = 'y', `b[i2][j1]` = 'z') when nested = FALSE.

    +
    @@ -114,7 +117,7 @@ list(i1 = list(j1 = 'x')), b = list(i1 = list(j1 = 'y'), i2 = list(j1 =
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/passwordInput.html b/reference/passwordInput.html index 9b82769d6..2d43064a9 100644 --- a/reference/passwordInput.html +++ b/reference/passwordInput.html @@ -60,21 +60,32 @@

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    value

    Initial value.

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    placeholder

    A character string giving the user a hint as to what can be entered into the control. Internet Explorer 8 and 9 do not support this option.

    +

    Value

    -

    A text input control that can be added to a UI definition.

    + + +

    A text input control that can be added to a UI definition.

    Server value

    @@ -135,7 +146,7 @@ unless value is provided.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/plotOutput.html b/reference/plotOutput.html index ecbdd0cbe..2c257e05c 100644 --- a/reference/plotOutput.html +++ b/reference/plotOutput.html @@ -82,6 +82,8 @@ application page.

    Arguments

    outputId

    output variable to read the plot/image from.

    + +
    width, height

    Image width/height. Must be a valid CSS unit (like "100%", "400px", "auto") or a number, which will be @@ -90,6 +92,8 @@ ignored when inline = TRUE, in which case the width/height of a plo must be specified in renderPlot(). Note that, for height, using "auto" or "100%" generally will not work as expected, because of how height is computed with HTML/CSS.

    + +
    click

    This can be NULL (the default), a string, or an object created by the clickOpts() function. If you use a value like @@ -98,9 +102,13 @@ the plot will send coordinates to the server whenever it is clicked, and the value will be accessible via input$plot_click. The value will be a named list with x and y elements indicating the mouse position.

    + +
    dblclick

    This is just like the click argument, but for double-click events.

    + +
    hover

    Similar to the click argument, this can be NULL (the default), a string, or an object created by the @@ -111,6 +119,8 @@ value will be accessible via input$plot_hover. The value will be a named list with x and y elements indicating the mouse position. To control the hover time or hover delay type, you must use hoverOpts().

    + +
    brush

    Similar to the click argument, this can be NULL (the default), a string, or an object created by the @@ -126,13 +136,18 @@ behavior, use brushOpts(). Multiple imageOutput/plotOutput calls may share the same id value; brushing one image or plot will cause any other brushes with the same id to disappear.

    + +
    inline

    use an inline (span()) or block container (div()) for the output

    +

    Value

    -

    A plot or image output element that can be included in a panel.

    + + +

    A plot or image output element that can be included in a panel.

    Note

    @@ -341,7 +356,7 @@ properly scaled to the data space.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/plotPNG.html b/reference/plotPNG.html index 46b2fd08e..cbf051c96 100644 --- a/reference/plotPNG.html +++ b/reference/plotPNG.html @@ -73,20 +73,31 @@ way.

    Arguments

    func

    A function that generates a plot.

    + +
    filename

    The name of the output file. Defaults to a temp file with extension .png.

    + +
    width

    Width in pixels.

    + +
    height

    Height in pixels.

    + +
    res

    Resolution in pixels per inch. This value is passed to grDevices::png(). Note that this affects the resolution of PNG rendering in R; it won't change the actual ppi of the browser.

    + +
    ...

    Arguments to be passed through to grDevices::png(). These can be used to set the width, height, background color, etc.

    +

    Details

    @@ -112,7 +123,7 @@ antialias some point shapes, resulting in poor quality output.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/radioButtons.html b/reference/radioButtons.html index 5d81c60f2..7807b32f0 100644 --- a/reference/radioButtons.html +++ b/reference/radioButtons.html @@ -69,23 +69,35 @@

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    choices

    List of values to select from (if elements of the list are named then that name rather than the value is displayed to the user). If this argument is provided, then choiceNames and choiceValues must not be provided, and vice-versa. The values should be strings; other types (such as logicals and numbers) will be coerced to strings.

    + +
    selected

    The initially selected value. If not specified, then it defaults to the first item in choices. To start with no items selected, use character(0).

    + +
    inline

    If TRUE, render the choices inline (i.e. horizontally)

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    choiceNames, choiceValues

    List of names and values, respectively, that are displayed to the user in the app and correspond to the each choice (for @@ -95,10 +107,13 @@ and choices must not be provided. The advantage of using b over a named list for choices is that choiceNames allows any type of UI object to be passed through (tag objects, icons, HTML code, ...), instead of just simple text. See Examples.

    +

    Value

    -

    A set of radio buttons that can be added to a UI definition.

    + + +

    A set of radio buttons that can be added to a UI definition.

    Details

    @@ -199,7 +214,7 @@ having the first of your choices be c("None selected" = "").

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactive.html b/reference/reactive.html index 9c4452abc..a8ede85c7 100644 --- a/reference/reactive.html +++ b/reference/reactive.html @@ -72,29 +72,44 @@ reactive expression is a expression whose result will change over time.

    Arguments

    x

    For is.reactive(), an object to test. For reactive(), an expression. When passing in a quo()sure with reactive(), remember to use rlang::inject() to distinguish that you are passing in the content of your quosure, not the expression of the quosure.

    + +
    env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If x is a quosure and quoted is TRUE, then env is ignored.

    + +
    quoted

    If it is TRUE, then the quote()ed value of x will be used when x is evaluated. If x is a quosure and you would like to use its expression as a value for x, then you must set quoted to TRUE.

    + +
    ...

    Not used.

    + +
    label

    A label for the reactive expression, useful for debugging.

    + +
    domain

    See domains.

    + +
    ..stacktraceon

    Advanced use only. For stack manipulation purposes; see stacktrace().

    +

    Value

    -

    a function, wrapped in a S3 class "reactive"

    + + +

    a function, wrapped in a S3 class "reactive"

    Details

    @@ -130,7 +145,7 @@ more information about reactive expressions.

    isolate(reactiveC()) #> <quosure> #> expr: ^values$A + 2 -#> env: 0x559383093270 +#> env: 0x560129f1bce0 # Instead, the quosure should be `rlang::inject()`ed reactiveD <- rlang::inject(reactive(!!myquo)) @@ -159,7 +174,7 @@ more information about reactive expressions.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactiveConsole.html b/reference/reactiveConsole.html index 495d144b9..881141df7 100644 --- a/reference/reactiveConsole.html +++ b/reference/reactiveConsole.html @@ -62,6 +62,7 @@ at the console, for the purposes of experimentation and learning.

    Arguments

    enabled

    Turn console reactivity on or off?

    +
    @@ -88,7 +89,7 @@ at the console, for the purposes of experimentation and learning.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactiveFileReader.html b/reference/reactiveFileReader.html index 5cc1e021e..44b9dd12b 100644 --- a/reference/reactiveFileReader.html +++ b/reference/reactiveFileReader.html @@ -64,25 +64,36 @@ contents of the file.

    Approximate number of milliseconds to wait between checks of the file's last modified time. This can be a numeric value, or a function that returns a numeric value.

    + +
    session

    The user session to associate this file reader with, or NULL if none. If non-null, the reader will automatically stop when the session ends.

    + +
    filePath

    The file path to poll against and to pass to readFunc. This can either be a single-element character vector, or a function that returns one.

    + +
    readFunc

    The function to use to read the file; must expect the first argument to be the file path to read. The return value of this function is used as the value of the reactive file reader.

    + +
    ...

    Any additional arguments to pass to readFunc whenever it is invoked.

    +

    Value

    -

    A reactive expression that returns the contents of the file, and + + +

    A reactive expression that returns the contents of the file, and automatically invalidates when the file changes on disk (as determined by last modified time).

    @@ -136,7 +147,7 @@ reactive values and reactive expressions.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactivePoll.html b/reference/reactivePoll.html index 065bf2a64..7544c2124 100644 --- a/reference/reactivePoll.html +++ b/reference/reactivePoll.html @@ -64,22 +64,31 @@ non-reactive data source.

    Approximate number of milliseconds to wait between calls to checkFunc. This can be either a numeric value, or a function that returns a numeric value.

    + +
    session

    The user session to associate this file reader with, or NULL if none. If non-null, the reader will automatically stop when the session ends.

    + +
    checkFunc

    A relatively cheap function whose values over time will be tested for equality; inequality indicates that the underlying value has changed and needs to be invalidated and re-read using valueFunc. See Details.

    + +
    valueFunc

    A function that calculates the underlying value. See Details.

    +

    Value

    -

    A reactive expression that returns the result of valueFunc, + + +

    A reactive expression that returns the result of valueFunc, and invalidates when checkFunc changes.

    @@ -151,7 +160,7 @@ values and reactive expressions.

    #> data() #> }) #> } -#> <environment: 0x5593813e68d0> +#> <environment: 0x560127fdf968>
    @@ -166,7 +175,7 @@ values and reactive expressions.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactiveTimer.html b/reference/reactiveTimer.html index 96db65162..d8bcdcdbd 100644 --- a/reference/reactiveTimer.html +++ b/reference/reactiveTimer.html @@ -64,15 +64,20 @@ reactive timers are triggered simply by the passage of time.

    Arguments

    intervalMs

    How often to fire, in milliseconds

    + +
    session

    A session object. This is needed to cancel any scheduled invalidations after a user has ended the session. If NULL, then this invalidation will not be tied to any session, and so it will still occur.

    +

    Value

    -

    A no-parameter function that can be called from a reactive context, + + +

    A no-parameter function that can be called from a reactive context, in order to cause that context to be invalidated the next time the timer interval elapses. Calling the returned function also happens to yield the current time (as in base::Sys.time()).

    @@ -141,7 +146,7 @@ needed.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactiveVal.html b/reference/reactiveVal.html index 7c82a9920..0e48ed110 100644 --- a/reference/reactiveVal.html +++ b/reference/reactiveVal.html @@ -70,14 +70,19 @@ that previously depended on that value.

    Arguments

    value

    An optional initial value.

    + +
    label

    An optional label, for debugging purposes (see reactlog()). If missing, a label will be automatically created.

    +

    Value

    -

    A function. Call the function with no arguments to (reactively) read + + +

    A function. Call the function with no arguments to (reactively) read the value; call the function with a single argument to set the value.

    @@ -152,7 +157,7 @@ use reactiveVal. See the Examples section for an illustration.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactiveValues.html b/reference/reactiveValues.html index e4a731033..8f88ff659 100644 --- a/reference/reactiveValues.html +++ b/reference/reactiveValues.html @@ -71,6 +71,7 @@ object are reactive, but the reactiveValues object itself is not.

    ...

    Objects that will be added to the reactivevalues object. All of these objects must be named.

    +

    See also

    @@ -118,7 +119,7 @@ these objects must be named.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactiveValuesToList.html b/reference/reactiveValuesToList.html index d48abf135..f024fbdc0 100644 --- a/reference/reactiveValuesToList.html +++ b/reference/reactiveValuesToList.html @@ -66,9 +66,12 @@ dependencies on all the objects, you can wrap the call with @@ -99,7 +102,7 @@ dependencies on all the objects, you can wrap the call with -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reactlog.html b/reference/reactlog.html index 7077e1c90..4feed9717 100644 --- a/reference/reactlog.html +++ b/reference/reactlog.html @@ -67,6 +67,7 @@ dependencies and execution in your application.

    time

    A boolean that specifies whether or not to display the time that each reactive takes to calculate a result.

    +

    Details

    @@ -115,7 +116,7 @@ of the source code of your reactive expressions and observers.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/reexports.html b/reference/reexports.html index 050fd96fd..bee14f3f3 100644 --- a/reference/reexports.html +++ b/reference/reexports.html @@ -86,7 +86,7 @@ below to see their documentation.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/registerInputHandler.html b/reference/registerInputHandler.html index cd100df11..6404e63f9 100644 --- a/reference/registerInputHandler.html +++ b/reference/registerInputHandler.html @@ -67,6 +67,8 @@ of the server.R file.

    type

    The type for which the handler should be added --- should be a single-element character vector.

    + +
    fun

    The handler function. This is the function that will be used to parse the data delivered from the client before it is available in the @@ -77,10 +79,13 @@ client, deserialized using jsonlite.

    input exists.

  • The name of the input.

    • + +
    force

    If TRUE, will overwrite any existing handler without warning. If FALSE, will throw an error if this class already has a handler defined.

    +

    Details

    @@ -130,7 +135,7 @@ package's -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/registerThemeDependency.html b/reference/registerThemeDependency.html index bb80a1e7c..6ec4dbba3 100644 --- a/reference/registerThemeDependency.html +++ b/reference/registerThemeDependency.html @@ -66,6 +66,7 @@ be re-executed, and the resulting html dependency will be sent to the client.

    A function that takes one argument, theme (which is a sass::sass_layer() object), and returns an htmlDependency object, or list of them.

    +

    Details

    @@ -87,7 +88,7 @@ tries to deduplicate them

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/removeInputHandler.html b/reference/removeInputHandler.html index b4edcfa87..76d796bc9 100644 --- a/reference/removeInputHandler.html +++ b/reference/removeInputHandler.html @@ -62,10 +62,13 @@ for data of this type, the default jsonlite serialization will be used.

    Arguments

    type

    The type for which handlers should be removed.

    +

    Value

    -

    The handler previously associated with this type, if one + + +

    The handler previously associated with this type, if one existed. Otherwise, NULL.

    @@ -85,7 +88,7 @@ existed. Otherwise, NULL.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/renderCachedPlot.html b/reference/renderCachedPlot.html index 2808d8123..f3fe6346b 100644 --- a/reference/renderCachedPlot.html +++ b/reference/renderCachedPlot.html @@ -73,10 +73,14 @@ this is a shortcut for using bindCache()Arguments
    expr

    An expression that generates a plot.

    + +
    cacheKeyExpr

    An expression that returns a cache key. This key should be a unique identifier for a plot: the assumption is that if the cache key is the same, then the plot will be the same.

    + +
    sizePolicy

    A function that takes two arguments, width and height, and returns a list with width and height. The @@ -84,15 +88,23 @@ purpose is to round the actual pixel dimensions from the browser to some other dimensions, so that this will not generate and cache images of every possible pixel dimension. See sizeGrowthRatio() for more information on the default sizing policy.

    + +
    res

    The resolution of the PNG, in pixels per inch.

    + +
    cache

    The scope of the cache, or a cache object. This can be "app" (the default), "session", or a cache object like a cachem::cache_disk(). See the Cache Scoping section for more information.

    + +
    ...

    Arguments to be passed through to grDevices::png(). These can be used to set the width, height, background color, etc.

    + +
    alt

    Alternate text for the HTML <img> tag if it cannot be displayed or viewed (i.e., the user uses a screen reader). In addition to a character @@ -102,13 +114,18 @@ default), then NULL or "" is not recommended because those should be limited to decorative images.

    + +
    outputArgs

    A list of arguments to be passed through to the implicit call to plotOutput() when renderPlot is used in an interactive R Markdown document.

    + +
    width, height

    not used. They are specified via the argument sizePolicy.

    +

    Details

    @@ -308,7 +325,7 @@ function. It can be used with bindCache()
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/renderDataTable.html b/reference/renderDataTable.html index 08ddad8c2..c0a43d192 100644 --- a/reference/renderDataTable.html +++ b/reference/renderDataTable.html @@ -93,8 +93,12 @@ Learn more at quote()ed value of expr will be used when expr is evaluated. If expr is a quosure and you would like to use its expression as a value for expr, then you must set quoted to TRUE.

    + +
    outputArgs

    A list of arguments to be passed through to the implicit call to dataTableOutput() when renderDataTable() is used in an interactive R Markdown document.

    +
    @@ -172,7 +189,7 @@ in an interactive R Markdown document.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/renderImage.html b/reference/renderImage.html index 56c062942..ef6654484 100644 --- a/reference/renderImage.html +++ b/reference/renderImage.html @@ -68,16 +68,22 @@ slot.

    Arguments

    expr

    An expression that returns a list.

    + +
    env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If expr is a quosure and quoted is TRUE, then env is ignored.

    + +
    quoted

    If it is TRUE, then the quote()ed value of expr will be used when expr is evaluated. If expr is a quosure and you would like to use its expression as a value for expr, then you must set quoted to TRUE.

    + +
    deleteFile

    Should the file in func()$src be deleted after it is sent to the client browser? Generally speaking, if the image is a @@ -86,10 +92,13 @@ if the image is not a temp file, this should be FALSE. (For backwar compatibility reasons, if this argument is missing, a warning will be emitted, and if the file is in the temp directory it will be deleted. In the future, this warning will become an error.)

    + +
    outputArgs

    A list of arguments to be passed through to the implicit call to imageOutput() when renderImage is used in an interactive R Markdown document.

    +

    Details

    @@ -193,7 +202,7 @@ the output, see plotPNG().

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/renderPlot.html b/reference/renderPlot.html index 04e2a6128..dfc346a89 100644 --- a/reference/renderPlot.html +++ b/reference/renderPlot.html @@ -73,6 +73,8 @@ slot.

    Arguments

    expr

    An expression that generates a plot.

    + +
    width, height

    Height and width can be specified in three ways:

    • "auto", the default, uses the size specified by plotOutput() (i.e. the offsetWidth/`offsetHeight`` of the HTML element bound to @@ -83,13 +85,19 @@ The function is executed in a reactive context so that you can refer to reactive values and expression to make the width/height reactive.

    When rendering an inline plot, you must provide numeric values (in pixels) to both width and height.

    + +
    res

    Resolution of resulting plot, in pixels per inch. This value is passed to grDevices::png(). Note that this affects the resolution of PNG rendering in R; it won't change the actual ppi of the browser.

    + +
    ...

    Arguments to be passed through to grDevices::png(). These can be used to set the width, height, background color, etc.

    + +
    alt

    Alternate text for the HTML <img> tag if it cannot be displayed or viewed (i.e., the user uses a screen reader). In addition to a character @@ -99,16 +107,22 @@ default), then NULL or "" is not recommended because those should be limited to decorative images.

    + +
    env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If expr is a quosure and quoted is TRUE, then env is ignored.

    + +
    quoted

    If it is TRUE, then the quote()ed value of expr will be used when expr is evaluated. If expr is a quosure and you would like to use its expression as a value for expr, then you must set quoted to TRUE.

    + +
    execOnResize

    If FALSE (the default), then when a plot is resized, Shiny will replay the plot drawing commands with @@ -116,10 +130,13 @@ resized, Shiny will replay the plot drawing commands with This can result in faster plot redrawing, but there may be rare cases where it is undesirable. If you encounter problems when resizing a plot, you can have Shiny re-execute the code on resize by setting this to TRUE.

    + +
    outputArgs

    A list of arguments to be passed through to the implicit call to plotOutput() when renderPlot is used in an interactive R Markdown document.

    +

    Details

    @@ -158,7 +175,7 @@ expedite the rendering of identical plots.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/renderPrint.html b/reference/renderPrint.html index 8a32b12cf..90ef17d1e 100644 --- a/reference/renderPrint.html +++ b/reference/renderPrint.html @@ -84,29 +84,45 @@ printed output generated while evaluating expr.

    Arguments

    expr

    An expression to evaluate.

    + +
    env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If expr is a quosure and quoted is TRUE, then env is ignored.

    + +
    quoted

    If it is TRUE, then the quote()ed value of expr will be used when expr is evaluated. If expr is a quosure and you would like to use its expression as a value for expr, then you must set quoted to TRUE.

    + +
    width

    Width of printed output.

    + +
    outputArgs

    A list of arguments to be passed through to the implicit call to verbatimTextOutput() or textOutput() when the functions are used in an interactive RMarkdown document.

    + +
    sep

    A separator passed to cat to be appended after each element.

    +

    Value

    -

    For renderPrint(), note the given expression returns NULL then NULLwill actually be visible in the output. To display nothing, make your + + +

    For renderPrint(), note the given expression returns NULL then NULL

    + + +

    will actually be visible in the output. To display nothing, make your function return invisible().

    @@ -196,7 +212,7 @@ have the CSS class name shiny-text-output.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/renderTable.html b/reference/renderTable.html index d6b16959a..b7927923c 100644 --- a/reference/renderTable.html +++ b/reference/renderTable.html @@ -86,20 +86,30 @@ page.

    Arguments

    outputId

    output variable to read the table from

    + +
    expr

    An expression that returns an R object that can be used with xtable::xtable().

    + +
    striped, hover, bordered

    Logicals: if TRUE, apply the corresponding Bootstrap table format to the output table.

    + +
    spacing

    The spacing between the rows of the table (xs stands for "extra small", s for "small", m for "medium" and l for "large").

    + +
    width

    Table width. Must be a valid CSS unit (like "100%", "400px", "auto") or a number, which will be coerced to a string and have "px" appended.

    + +
    align

    A string that specifies the column alignment. If equal to 'l', 'c' or 'r', then all columns will be, @@ -114,35 +124,50 @@ alignment). If NULL, then all numeric/integer columns (including the row names, if they are numbers) will be right-aligned and everything else will be left-aligned (align = '?' produces the same result).

    + +
    rownames, colnames

    Logicals: include rownames? include colnames (column headers)?

    + +
    digits

    An integer specifying the number of decimal places for the numeric columns (this will not apply to columns with an integer class). If digits is set to a negative value, then the numeric columns will be displayed in scientific format with a precision of abs(digits) digits.

    + +
    na

    The string to use in the table cells whose values are missing (i.e. they either evaluate to NA or NaN).

    + +
    ...

    Arguments to be passed through to xtable::xtable() and xtable::print.xtable().

    + +
    env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If expr is a quosure and quoted is TRUE, then env is ignored.

    + +
    quoted

    If it is TRUE, then the quote()ed value of expr will be used when expr is evaluated. If expr is a quosure and you would like to use its expression as a value for expr, then you must set quoted to TRUE.

    + +
    outputArgs

    A list of arguments to be passed through to the implicit call to tableOutput() when renderTable is used in an interactive R Markdown document.

    +
    @@ -177,7 +202,7 @@ used in an interactive R Markdown document.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/renderUI.html b/reference/renderUI.html index e1550ebc9..340b8d3a5 100644 --- a/reference/renderUI.html +++ b/reference/renderUI.html @@ -61,20 +61,27 @@
    expr

    An expression that returns a Shiny tag object, HTML(), or a list of such objects.

    + +
    env

    The parent environment for the reactive expression. By default, this is the calling environment, the same as when defining an ordinary non-reactive expression. If expr is a quosure and quoted is TRUE, then env is ignored.

    + +
    quoted

    If it is TRUE, then the quote()ed value of expr will be used when expr is evaluated. If expr is a quosure and you would like to use its expression as a value for expr, then you must set quoted to TRUE.

    + +
    outputArgs

    A list of arguments to be passed through to the implicit call to uiOutput() when renderUI is used in an interactive R Markdown document.

    +

    Details

    @@ -120,7 +127,7 @@ name shiny-html-output (or use uiOu
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/repeatable.html b/reference/repeatable.html index badad7a18..b9aa33d04 100644 --- a/reference/repeatable.html +++ b/reference/repeatable.html @@ -64,12 +64,17 @@ be passed in explicitly if desired; otherwise, a random number is used.

    Arguments

    rngfunc

    The function that is affected by the R session's seed.

    + +
    seed

    The seed to set every time the resulting function is called.

    +

    Value

    -

    A repeatable version of the function that was passed in.

    + + +

    A repeatable version of the function that was passed in.

    Note

    @@ -83,13 +88,13 @@ current seed by snapshotting and restoring 
    rnormA <- repeatable(rnorm)
 rnormB <- repeatable(rnorm)
 rnormA(3)  # [1]  1.8285879 -0.7468041 -0.4639111
-#> [1] -0.2996441 -0.6167677  0.0649823
+#> [1] -0.3712595  1.4753488 -0.9674740
 rnormA(3)  # [1]  1.8285879 -0.7468041 -0.4639111
-#> [1] -0.2996441 -0.6167677  0.0649823
+#> [1] -0.3712595  1.4753488 -0.9674740
 rnormA(5)  # [1]  1.8285879 -0.7468041 -0.4639111 -1.6510126 -1.4686924
-#> [1] -0.2996441 -0.6167677  0.0649823  0.8301923 -1.0196285
+#> [1] -0.37125952  1.47534877 -0.96747397 -0.02820583 -0.26208832
 rnormB(5)  # [1] -0.7946034  0.2568374 -0.6567597  1.2451387 -0.8375699
-#> [1] -0.8385125 -0.3955150 -0.4552046 -0.9322165 -2.1241452
+#> [1]  0.55542418 -0.08294965 -1.23711721 -0.99316342 -1.24846116
    @@ -104,7 +109,7 @@ current seed by snapshotting and restoring
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/req.html b/reference/req.html index 47125bdaa..85a5fde9c 100644 --- a/reference/req.html +++ b/reference/req.html @@ -66,27 +66,42 @@ nor displayed in the Shiny app's UI).

    Arguments

    ...

    Values to check for truthiness.

    + +
    cancelOutput

    If TRUE and an output is being evaluated, stop processing as usual but instead of clearing the output, leave it in whatever state it happens to be in.

    +

    Value

    -

    The first value that was passed in.

    + + +

    The first value that was passed in.

    Details

    The req function was designed to be used in one of two ways. The first is to call it like a statement (ignoring its return value) before attempting operations using the required values:

    -

    +

    rv <- reactiveValues(state = FALSE)
+r <- reactive({
+  req(input$a, input$b, rv$state)
+  # Code that uses input$a, input$b, and/or rv$state...
+})

    In this example, if r() is called and any of input$a, input$b, and rv$state are NULL, FALSE, "", etc., then the req call will trigger an error that propagates all the way up to whatever render block or observer is executing.

    The second is to use it to wrap an expression that must be truthy:

    -

    +

    output$plot <- renderPlot({
+  if (req(input$plotType) == "histogram") {
+    hist(dataset())
+  } else if (input$plotType == "scatter") {
+    qplot(dataset(), aes(x = x, y = y))
+  }
+})

    In this example, req(input$plotType) first checks that input$plotType is truthy, and if so, returns it. This is a convenient way to check for a value "inline" with its first use.

    @@ -159,7 +174,7 @@ as a result of those calls. See the examples below for concrete scenarios.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/resourcePaths.html b/reference/resourcePaths.html index 41fbf6c73..3a53bc786 100644 --- a/reference/resourcePaths.html +++ b/reference/resourcePaths.html @@ -71,9 +71,12 @@ supporting JavaScript/CSS files available to their components.

    A-Z, 0-9, hyphen, period, and underscore. For example, a value of 'foo' means that any request paths that begin with '/foo' will be mapped to the given directory.

    + +
    directoryPath

    The directory that contains the static resources to be served.

    +

    Details

    @@ -119,7 +122,7 @@ supporting JavaScript/CSS files available to their components.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/restoreInput.html b/reference/restoreInput.html index fdad51be1..3db0ead17 100644 --- a/reference/restoreInput.html +++ b/reference/restoreInput.html @@ -62,8 +62,11 @@ called early on inside of input functions (like t

    Arguments

    id

    Name of the input value to restore.

    + +
    default

    A default value to use, if there's no value to restore.

    +
    @@ -78,7 +81,7 @@ called early on inside of input functions (like     t
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/runApp.html b/reference/runApp.html index d8540063d..c4bd8c091 100644 --- a/reference/runApp.html +++ b/reference/runApp.html @@ -78,6 +78,8 @@ expression that produces a Shiny app object.

  • A list with ui and server components.

  • A Shiny app object created by shinyApp().

    • + +
    port

    The TCP port that the application should listen on. If the port is not specified, and the shiny.port option is set (with @@ -86,20 +88,30 @@ use a random port between 3000:8000, excluding ports that are blocked by Google Chrome for being considered unsafe: 3659, 4045, 5060, 5061, 6000, 6566, 6665:6669 and 6697. Up to twenty random ports will be tried.

    + +
    launch.browser

    If true, the system's default web browser will be launched automatically after the app is started. Defaults to true in interactive sessions only. The value of this parameter can also be a function to call with the application's URL.

    + +
    host

    The IPv4 address that the application should listen on. Defaults to the shiny.host option, if set, or "127.0.0.1" if not. See Details.

    + +
    workerId

    Can generally be ignored. Exists to help some editions of Shiny Server Pro route requests to the correct process.

    + +
    quiet

    Should Shiny status messages be shown? Defaults to FALSE.

    + +
    display.mode

    The mode in which to display the application. If set to the value "showcase", shows application code and metadata from a @@ -107,10 +119,13 @@ the value "showcase", shows application code and metadata from a application. If set to "normal", displays the application normally. Defaults to "auto", which displays the application in the mode given in its DESCRIPTION file, if any.

    + +
    test.mode

    Should the application be launched in test mode? This is only used for recording or running automated tests. Defaults to the shiny.testmode option, or FALSE if the option is not set.

    +

    Details

    @@ -173,7 +188,7 @@ value that was hard-coded into Shiny in 0.8.0 and earlier).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/runExample.html b/reference/runExample.html index f1611cd31..f27ab53da 100644 --- a/reference/runExample.html +++ b/reference/runExample.html @@ -67,6 +67,8 @@
    example

    The name of the example to run, or NA (the default) to list the available examples.

    + +
    port

    The TCP port that the application should listen on. If the port is not specified, and the shiny.port option is set (with @@ -75,17 +77,24 @@ use a random port between 3000:8000, excluding ports that are blocked by Google Chrome for being considered unsafe: 3659, 4045, 5060, 5061, 6000, 6566, 6665:6669 and 6697. Up to twenty random ports will be tried.

    + +
    launch.browser

    If true, the system's default web browser will be launched automatically after the app is started. Defaults to true in interactive sessions only.

    + +
    host

    The IPv4 address that the application should listen on. Defaults to the shiny.host option, if set, or "127.0.0.1" if not.

    + +
    display.mode

    The mode in which to display the example. Defaults to showcase, but may be set to normal to see the example without code or commentary.

    +
    @@ -115,7 +124,7 @@ code or commentary.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/runGadget.html b/reference/runGadget.html index efa6609fd..7c0ac4f13 100644 --- a/reference/runGadget.html +++ b/reference/runGadget.html @@ -69,24 +69,35 @@ if running in RStudio, defaults to viewing the app in the Viewer pane.

    app

    Either a Shiny app object as created by shinyApp() et al, or, a UI object.

    + +
    server

    Ignored if app is a Shiny app object; otherwise, passed along to shinyApp (i.e. shinyApp(ui = app, server = server)).

    + +
    port

    See runApp().

    + +
    viewer

    Specify where the gadget should be displayed--viewer pane, dialog window, or external browser--by passing in a call to one of the viewer() functions.

    + +
    stopOnCancel

    If TRUE (the default), then an observeEvent is automatically created that handles input$cancel by calling stopApp() with an error. Pass FALSE if you want to handle input$cancel yourself.

    +

    Value

    -

    The value returned by the gadget.

    + + +

    The value returned by the gadget.

    @@ -120,7 +131,7 @@ is automatically created that handles input$cancel by calling
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/runTests.html b/reference/runTests.html index 8e27bbd3c..90ecb22e5 100644 --- a/reference/runTests.html +++ b/reference/runTests.html @@ -64,18 +64,27 @@ directories under tests/.

    Arguments

    appDir

    The base directory for the application.

    + +
    filter

    If not NULL, only tests with file names matching this regular expression will be executed. Matching is performed on the file name including the extension.

    + +
    assert

    Logical value which determines if an error should be thrown if any error is captured.

    + +
    envir

    Parent testing environment in which to base the individual testing environments.

    +

    Value

    -

    A data frame classed with the supplemental class "shiny_runtests". + + +

    A data frame classed with the supplemental class "shiny_runtests". The data frame has the following columns:

    NameTypeMeaning
    filecharacter(1)File name of the runner script in tests/ that was sourced.
    passlogical(1)Whether or not the runner script signaled an error when sourced.
    resultany or NAThe return value of the runner

    Details

    @@ -97,7 +106,7 @@ Please see shinyAppTemplate() f
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/runUrl.html b/reference/runUrl.html index 2f08c3544..3ef79ee26 100644 --- a/reference/runUrl.html +++ b/reference/runUrl.html @@ -85,34 +85,51 @@ respectively.

    Arguments

    url

    URL of the application.

    + +
    filetype

    The file type (".zip", ".tar", or ".tar.gz". Defaults to the file extension taken from the url.

    + +
    subdir

    A subdirectory in the repository that contains the app. By default, this function will run an app from the top level of the repo, but you can use a path such as "inst/shinyapp".

    + +
    destdir

    Directory to store the downloaded application files. If NULL (the default), the application files will be stored in a temporary directory and removed when the app exits

    + +
    ...

    Other arguments to be passed to runApp(), such as port and launch.browser.

    + +
    gist

    The identifier of the gist. For example, if the gist is https://gist.github.com/jcheng5/3239667, then 3239667, '3239667', and 'https://gist.github.com/jcheng5/3239667' are all valid values.

    + +
    repo

    Name of the repository.

    + +
    username

    GitHub username. If repo is of the form "username/repo", username will be taken from repo.

    + +
    ref

    Desired git reference. Could be a commit, tag, or branch name. Defaults to "HEAD", which means the default branch on GitHub, typically "main" or "master".

    +
    @@ -156,7 +173,7 @@ Defaults to "HEAD", which means the default branch on GitHub, typic
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/safeError.html b/reference/safeError.html index 004334cd3..e4a6d9ee7 100644 --- a/reference/safeError.html +++ b/reference/safeError.html @@ -70,10 +70,13 @@ display the error in the app itself.

    Either an "error" object or a "character" object (string). In the latter case, the string will become the message of the error returned by safeError.

    +

    Value

    -

    An "error" object

    + + +

    An "error" object

    Details

    @@ -150,7 +153,7 @@ error occurred.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/selectInput.html b/reference/selectInput.html index 01ef9add7..5dd195ce3 100644 --- a/reference/selectInput.html +++ b/reference/selectInput.html @@ -73,8 +73,12 @@ from a list of values.

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    choices

    List of values to select from. If elements of the list are named, then that name --- rather than the value --- is displayed to the @@ -83,32 +87,49 @@ whose elements are (either named or unnamed) lists, vectors, or factors. In this case, the outermost names will be used as the group labels (leveraging the <optgroup> HTML tag) for the elements in the respective sublist. See the example section for a small demo of this feature.

    + +
    selected

    The initially selected value (or multiple values if multiple = TRUE). If not specified then defaults to the first value for single-select lists and no values for multiple select lists.

    + +
    multiple

    Is selection of multiple items allowed?

    + +
    selectize

    Whether to use selectize.js or not.

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    size

    Number of items to show in the selection box; a larger number will result in a taller box. Not compatible with selectize=TRUE. Normally, when multiple=FALSE, a select input will be a drop-down list, but when size is set, it will be a box instead.

    + +
    ...

    Arguments passed to selectInput().

    + +
    options

    A list of options. See the documentation of selectize.js for possible options (character option values inside base::I() will be treated as literal JavaScript code; see renderDataTable() for details).

    +

    Value

    -

    A select list control that can be added to a UI definition.

    + + +

    A select list control that can be added to a UI definition.

    Details

    @@ -217,7 +238,7 @@ nothing is selected, this value will be NULL.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/serverInfo.html b/reference/serverInfo.html index 90f87b131..84cfaffe2 100644 --- a/reference/serverInfo.html +++ b/reference/serverInfo.html @@ -64,7 +64,9 @@ just returns list(shinyServer = FALSE).

    Value

    -

    A list of the Shiny Server information.

    + + +

    A list of the Shiny Server information.

    Details

    @@ -84,7 +86,7 @@ version 1.2.2 or later.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/session.html b/reference/session.html index 120a7effd..01bb238cf 100644 --- a/reference/session.html +++ b/reference/session.html @@ -76,6 +76,7 @@ If value is FALSE, reconnections will be disabled (thi the default state). If "force", then the client browser will always attempt to reconnect. The only reason to use "force" is for testing on a local connection (without Shiny Server or Connect).

    +
    clientData

    A reactiveValues() object that contains information about the client.

    • pixelratio reports the "device pixel ratio" from the web browser, or 1 if none is reported. The value is 2 for Apple Retina displays.

      • @@ -95,37 +96,47 @@ the DOM element that is bound to outputId, and output_outputId_hidden is a logical that indicates whether the element is hidden. These values may be NULL if the output is not bound.

    +
    input

    The session's input object (the same as is passed into the Shiny server function as an argument).

    +
    isClosed()

    A function that returns TRUE if the client has disconnected.

    +
    ns(id)

    Server-side version of ns <- NS(id). If bare IDs need to be explicitly namespaced for the current module, session$ns("name") will return the fully-qualified ID.

    +
    onEnded(callback)

    Synonym for onSessionEnded.

    +
    onFlush(func, once=TRUE)

    Registers a function to be called before the next time (if once=TRUE) or every time (if once=FALSE) Shiny flushes the reactive system. Returns a function that can be called with no arguments to cancel the registration.

    +
    onFlushed(func, once=TRUE)

    Registers a function to be called after the next time (if once=TRUE) or every time (if once=FALSE) Shiny flushes the reactive system. Returns a function that can be called with no arguments to cancel the registration.

    +
    onSessionEnded(callback)

    Registers a function to be called after the client has disconnected. Returns a function that can be called with no arguments to cancel the registration.

    +
    output

    The session's output object (the same as is passed into the Shiny server function as an argument).

    +
    reactlog

    For internal use.

    +
    registerDataObj(name, data, filterFunc)

    Publishes any R object as a URL endpoint that is unique to this session. name must be a single element character vector; it will be used @@ -136,25 +147,32 @@ the Rook specification for HTTP requests). filterFunc will be called with these values whenever an HTTP request is made to the URL endpoint. The return value of filterFunc should be a Rook-style response.

    +
    reload()

    The equivalent of hitting the browser's Reload button. Only works if the session is actually connected.

    +
    request

    An environment that implements the Rook specification for HTTP requests. This is the request that was used to initiate the websocket connection (as opposed to the request that downloaded the web page for the app).

    +
    userData

    An environment for app authors and module/package authors to store whatever session-specific data they want.

    +
    user

    User's log-in information. Useful for identifying users on hosted platforms such as RStudio Connect and Shiny Server.

    +
    groups

    The user's relevant group information. Useful for determining what privileges the user should or shouldn't have.

    +
    resetBrush(brushId)

    Resets/clears the brush with the given brushId, if it exists on any imageOutput or plotOutput in the app.

    +
    sendCustomMessage(type, message)

    Sends a custom message to the web page. type must be a single-element character vector giving the type of message, while @@ -166,12 +184,14 @@ JavaScript code to the browser that calls as the page loads; the function you provide to addCustomMessageHandler will be invoked each time sendCustomMessage is called on the server.

    +
    sendBinaryMessage(type, message)

    Similar to sendCustomMessage, but the message must be a raw vector and the registration method on the client is Shiny.addBinaryMessageHandler(type, function(message){...}). The message argument on the client will be a DataView.

    +
    sendInputMessage(inputId, message)

    Sends a message to an input on the session's client web page; if the input is present and bound on the page at the time the message is received, then @@ -179,25 +199,34 @@ the input binding object's receiveMessage(el, message) method will be called. sendInputMessage should generally not be called directly from Shiny apps, but through friendlier wrapper functions like updateTextInput().

    +
    setBookmarkExclude(names)

    Set input names to be excluded from bookmarking.

    +
    getBookmarkExclude()

    Returns the set of input names to be excluded from bookmarking.

    +
    onBookmark(fun)

    Registers a function that will be called just before bookmarking state.

    +
    onBookmarked(fun)

    Registers a function that will be called just after bookmarking state.

    +
    onRestore(fun)

    Registers a function that will be called when a session is restored, before all other reactives, observers, and render functions are run.

    +
    onRestored(fun)

    Registers a function that will be called when a session is restored, after all other reactives, observers, and render functions are run.

    +
    doBookmark()

    Do bookmarking and invoke the onBookmark and onBookmarked callback functions.

    +
    exportTestValues()

    Registers expressions for export in test mode, available at the test snapshot URL.

    +
    getTestSnapshotUrl(input=TRUE, output=TRUE, export=TRUE, format="json")

    Returns a URL for the test snapshots. Only has an effect when the @@ -206,6 +235,7 @@ export arguments, TRUE means to return all of these values. It is also possible to specify by name which values to return by providing a character vector, as in input=c("x", "y"). The format can be "rds" or "json".

    +
    setCurrentTheme(theme)

    Sets the current bootstrapLib() theme, which updates the value of getCurrentTheme(), invalidates session$getCurrentTheme(), and calls @@ -214,8 +244,10 @@ function(s) registered with registe stylesheets, then those stylesheets are "refreshed" (i.e., the new stylesheets are inserted on the page and the old ones are disabled and removed).

    +
    getCurrentTheme()

    A reactive read of the current bootstrapLib() theme.

    + @@ -230,7 +262,7 @@ removed).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/setBookmarkExclude.html b/reference/setBookmarkExclude.html index b33b51049..77aba968e 100644 --- a/reference/setBookmarkExclude.html +++ b/reference/setBookmarkExclude.html @@ -63,8 +63,11 @@ It should be called from inside the application's server function.

    names

    A character vector containing names of inputs to exclude from bookmarking.

    + +
    session

    A shiny session object.

    +

    Details

    @@ -90,7 +93,7 @@ application.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/setSerializer.html b/reference/setSerializer.html index 25dfd8d35..a955d5317 100644 --- a/reference/setSerializer.html +++ b/reference/setSerializer.html @@ -60,11 +60,16 @@

    Arguments

    inputId

    Name of the input value.

    + +
    fun

    A function that takes the input value and returns a modified value. The returned value will be used for the test snapshot.

    + +
    session

    A Shiny session object.

    +
    @@ -79,7 +84,7 @@ value. The returned value will be used for the test snapshot.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/shiny-package.html b/reference/shiny-package.html index 3c8705e46..37d52225c 100644 --- a/reference/shiny-package.html +++ b/reference/shiny-package.html @@ -82,7 +82,7 @@ includes extensive annotated examples.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/shiny.appobj.html b/reference/shiny.appobj.html index 9ac5c6934..f0d7fc5dc 100644 --- a/reference/shiny.appobj.html +++ b/reference/shiny.appobj.html @@ -77,8 +77,11 @@

    Arguments

    x

    Object to convert to a Shiny app.

    + +
    ...

    Ignored.

    +
    @@ -93,7 +96,7 @@
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/shinyApp.html b/reference/shinyApp.html index 5fd6c04c7..741c4051e 100644 --- a/reference/shinyApp.html +++ b/reference/shinyApp.html @@ -78,39 +78,56 @@ Shiny app (shinyAppDir).

    fluidPage() with nested controls).

    If bookmarking is enabled (see enableBookmarking), this must be a single argument function that returns the UI definition.

    + +
    server

    A function with three parameters: input, output, and session. The function is called once for each session ensuring that each app is independent.

    + +
    onStart

    A function that will be called before the app is actually run. This is only needed for shinyAppObj, since in the shinyAppDir case, a global.R file can be used for this purpose.

    + +
    options

    Named options that should be passed to the runApp call (these can be any of the following: "port", "launch.browser", "host", "quiet", "display.mode" and "test.mode"). You can also specify width and height parameters which provide a hint to the embedding environment about the ideal height/width for the app.

    + +
    uiPattern

    A regular expression that will be applied to each GET request to determine whether the ui should be used to handle the request. Note that the entire request path must match the regular expression in order for the match to be considered successful.

    + +
    enableBookmarking

    Can be one of "url", "server", or "disable". The default value, NULL, will respect the setting from any previous calls to enableBookmarking(). See enableBookmarking() for more information on bookmarking your app.

    + +
    appDir

    Path to directory that contains a Shiny app (i.e. a server.R file and either ui.R or www/index.html)

    + +
    appFile

    Path to a .R file containing a Shiny application

    +

    Value

    -

    An object that represents the app. Printing the object or passing it + + +

    An object that represents the app. Printing the object or passing it to runApp() will run the app.

    @@ -168,7 +185,7 @@ object to -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/shinyAppTemplate.html b/reference/shinyAppTemplate.html index 5da12679c..34e293382 100644 --- a/reference/shinyAppTemplate.html +++ b/reference/shinyAppTemplate.html @@ -60,6 +60,8 @@

    Arguments

    path

    Path to create new shiny application template.

    + +
    examples

    Either one of "default", "ask", "all", or any combination of "app", "rdir", "module", and "tests". In an @@ -68,18 +70,36 @@ session, "default" falls back to "all". With "ask", this function will prompt the user to select which template items will be added to the new app directory. With "all", all template items will be added to the app directory.

    + +
    dryrun

    If TRUE, don't actually write any files; just print out which files would be written.

    +

    Details

    In an interactive R session, this function will, by default, prompt the user to select which components to add to the application. Choices are

    -

    +

    1: All
+2: app.R              : Main application file
+3: R/example.R        : Helper file with R code
+4: R/example-module.R : Example module
+5: tests/testthat/    : Tests using the testthat and shinytest2 package

    If option 1 is selected, the full example application including the following files and directories is created:

    -

    +

    appdir/
+|- app.R
+|- R
+|   |- example-module.R
+|   `- example.R
+`- tests
+    |- testthat.R
+    `- testthat
+        |- test-examplemodule.R
+        |- test-server.R
+        |- test-shinytest2.R
+        `- test-sort.R

    Some notes about these files:

    • app.R is the main application file.

    • All files in the R/ subdirectory are automatically sourced when the application is run.

      • @@ -114,7 +134,7 @@ snapshot-based testing.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/shinyDeprecated.html b/reference/shinyDeprecated.html index 4ef48aca8..e21c5df60 100644 --- a/reference/shinyDeprecated.html +++ b/reference/shinyDeprecated.html @@ -66,12 +66,19 @@

    Arguments

    version

    Shiny version when the function was deprecated

    + +
    what

    Function with possible arguments

    + +
    with

    Possible function with arguments that should be used instead

    + +
    details

    Additional information to be added after a new line to the displayed message

    +
    @@ -86,7 +93,7 @@
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/shinyOptions.html b/reference/shinyOptions.html index 1bed0aad5..548c2aefb 100644 --- a/reference/shinyOptions.html +++ b/reference/shinyOptions.html @@ -86,10 +86,15 @@ internal use only.

    Arguments

    name

    Name of an option to get.

    + +
    default

    Value to be returned if the option is not currently set.

    + +
    ...

    Options to set, with the form name = value.

    +

    Options with options()

    @@ -272,7 +277,7 @@ used.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/shinyServer.html b/reference/shinyServer.html index 8c141e800..6429bab1b 100644 --- a/reference/shinyServer.html +++ b/reference/shinyServer.html @@ -95,6 +95,7 @@ on how to write a server function.

    func

    The server function for this application. See the details section for more information.

    +
    @@ -132,7 +133,7 @@ for more information.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/shinyUI.html b/reference/shinyUI.html index 01a1cfe04..633f302cc 100644 --- a/reference/shinyUI.html +++ b/reference/shinyUI.html @@ -70,10 +70,13 @@ returns the value that is passed to it.

    Arguments

    ui

    A user interace definition

    +

    Value

    -

    The user interface definition, without modifications or side effects.

    + + +

    The user interface definition, without modifications or side effects.

    @@ -88,7 +91,7 @@ returns the value that is passed to it.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/showBookmarkUrlModal.html b/reference/showBookmarkUrlModal.html index 4c7627741..9f5e9f070 100644 --- a/reference/showBookmarkUrlModal.html +++ b/reference/showBookmarkUrlModal.html @@ -68,6 +68,7 @@ or "server").

    Arguments

    url

    A URL to show in the modal dialog.

    +
    @@ -82,7 +83,7 @@ or "server").

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/showModal.html b/reference/showModal.html index f04841f25..9a1e764b1 100644 --- a/reference/showModal.html +++ b/reference/showModal.html @@ -64,9 +64,12 @@ typically used with modalDialog().Arguments
    ui

    UI content to show in the modal.

    + +
    session

    The session object passed to function given to shinyServer.

    +

    See also

    @@ -85,7 +88,7 @@ typically used with modalDialog().
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/showNotification.html b/reference/showNotification.html index dd0a29790..dcc46fb18 100644 --- a/reference/showNotification.html +++ b/reference/showNotification.html @@ -70,33 +70,48 @@

    Arguments

    ui

    Content of message.

    + +
    action

    Message content that represents an action. For example, this could be a link that the user can click on. This is separate from ui so customized layouts can handle the main notification content separately from action content.

    + +
    duration

    Number of seconds to display the message before it disappears. Use NULL to make the message not automatically disappear.

    + +
    closeButton

    If TRUE, display a button which will make the notification disappear when clicked. If FALSE do not display.

    + +
    id

    A unique identifier for the notification.

    id is optional for showNotification(): Shiny will automatically create one if needed. If you do supply it, Shiny will update an existing notification if it exists, otherwise it will create a new one.

    id is required for removeNotification().

    + +
    type

    A string which controls the color of the notification. One of "default" (gray), "message" (blue), "warning" (yellow), or "error" (red).

    + +
    session

    Session object to send notification to.

    +

    Value

    -

    An ID for the notification.

    + + +

    An ID for the notification.

    @@ -158,7 +173,7 @@ notification if it exists, otherwise it will create a new one.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/showTab.html b/reference/showTab.html index 6752b8266..b2f16913d 100644 --- a/reference/showTab.html +++ b/reference/showTab.html @@ -68,14 +68,21 @@ navlistPanel() or navbarPage()."><

    The id of the tabsetPanel (or navlistPanel or navbarPage) in which to find target.

    + +
    target

    The value of the tabPanel to be hidden/shown. See Details if you want to hide/show an entire navbarMenu instead.

    + +
    select

    Should target be selected upon being shown?

    + +
    session

    The shiny session within which to call this function.

    +

    Details

    @@ -149,7 +156,7 @@ this is equal to the value of the title argument).

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/sidebarLayout.html b/reference/sidebarLayout.html index 7126e72b9..2512df970 100644 --- a/reference/sidebarLayout.html +++ b/reference/sidebarLayout.html @@ -75,20 +75,31 @@ area occupies 2/3 of the horizontal width and typically contains outputs.

    Arguments

    sidebarPanel

    The sidebarPanel() containing input controls.

    + +
    mainPanel

    The mainPanel() containing outputs.

    + +
    position

    The position of the sidebar relative to the main area ("left" or "right").

    + +
    fluid

    TRUE to use fluid layout; FALSE to use fixed layout.

    + +
    ...

    Output elements to include in the sidebar/main panel.

    + +
    width

    The width of the sidebar and main panel. By default, the sidebar takes up 1/3 of the width, and the main panel 2/3. The total width must be 12 or less.

    +

    See also

    @@ -156,7 +167,7 @@ width must be 12 or less.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/sizeGrowthRatio.html b/reference/sizeGrowthRatio.html index b460259d6..bc54df7ee 100644 --- a/reference/sizeGrowthRatio.html +++ b/reference/sizeGrowthRatio.html @@ -72,8 +72,11 @@ widths.

    Arguments

    width, height

    Base width and height.

    + +
    growthRate

    Growth rate multiplier.

    +

    See also

    @@ -106,7 +109,7 @@ widths.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/sliderInput.html b/reference/sliderInput.html index 38e194b45..3f892bd09 100644 --- a/reference/sliderInput.html +++ b/reference/sliderInput.html @@ -86,43 +86,67 @@ range.

    Arguments

    inputId

    The input slot that will be used to access the value.

    + +
    label

    Display label for the control, or NULL for no label.

    + +
    min, max

    The minimum and maximum values (inclusive) that can be selected.

    + +
    value

    The initial value of the slider, either a number, a date (class Date), or a date-time (class POSIXt). A length one vector will create a regular slider; a length two vector will create a double-ended range slider. Must lie between min and max.

    + +
    step

    Specifies the interval between each selectable value on the slider. Either NULL, the default, which uses a heuristic to determine the step size or a single number. If the values are dates, step is in days; if the values are date-times, step is in seconds.

    + +
    round

    TRUE to round all values to the nearest integer; FALSE if no rounding is desired; or an integer to round to that number of digits (for example, 1 will round to the nearest 10, and -2 will round to the nearest .01). Any rounding will be applied after snapping to the nearest step.

    + +
    ticks

    FALSE to hide tick marks, TRUE to show them according to some simple heuristics.

    + +
    animate

    TRUE to show simple animation controls with default settings; FALSE not to; or a custom settings list, such as those created using animationOptions().

    + +
    width

    The width of the input, e.g. '400px', or '100%'; see validateCssUnit().

    + +
    sep

    Separator between thousands places in numbers.

    + +
    pre

    A prefix string to put in front of the value.

    + +
    post

    A suffix string to put after the value.

    + +
    timeFormat

    Only used if the values are Date or POSIXt objects. A time format string, to be passed to the Javascript strftime library. See @@ -131,29 +155,42 @@ format specifications are very similar, but not identical, to those for R's base::strftime() function. For Dates, the default is "%F" (like "2015-07-01"), and for POSIXt, the default is "%F %T" (like "2015-07-01 15:32:10").

    + +
    timezone

    Only used if the values are POSIXt objects. A string specifying the time zone offset for the displayed times, in the format "+HHMM" or "-HHMM". If NULL (the default), times will be displayed in the browser's time zone. The value "+0000" will result in UTC time.

    + +
    dragRange

    This option is used only if it is a range slider (with two values). If TRUE (the default), the range can be dragged. In other words, the min and max can be dragged together. If FALSE, the range cannot be dragged.

    + +
    interval

    The interval, in milliseconds, between each animation step.

    + +
    loop

    TRUE to automatically restart the animation when it reaches the end.

    + +
    playButton

    Specifies the appearance of the play button. Valid values are a one-element character vector (for a simple text label), an HTML tag or list of tags (using tag() and friends), or raw HTML (using HTML()).

    + +
    pauseButton

    Similar to playButton, but for the pause button.

    +

    Server value

    @@ -220,7 +257,7 @@ in the case of slider range, a vector of two numbers/dates/date-times.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/snapshotExclude.html b/reference/snapshotExclude.html index ca372c09f..c5a2afc4e 100644 --- a/reference/snapshotExclude.html +++ b/reference/snapshotExclude.html @@ -60,6 +60,7 @@

    Arguments

    x

    A reactive which will be assigned to an output.

    +
    @@ -74,7 +75,7 @@
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/snapshotPreprocessInput.html b/reference/snapshotPreprocessInput.html index 0658b5354..82700fe00 100644 --- a/reference/snapshotPreprocessInput.html +++ b/reference/snapshotPreprocessInput.html @@ -60,11 +60,16 @@

    Arguments

    inputId

    Name of the input value.

    + +
    fun

    A function that takes the input value and returns a modified value. The returned value will be used for the test snapshot.

    + +
    session

    A Shiny session object.

    +
    @@ -79,7 +84,7 @@ value. The returned value will be used for the test snapshot.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/snapshotPreprocessOutput.html b/reference/snapshotPreprocessOutput.html index 6351245e1..91ba325db 100644 --- a/reference/snapshotPreprocessOutput.html +++ b/reference/snapshotPreprocessOutput.html @@ -60,9 +60,12 @@

    Arguments

    x

    A reactive which will be assigned to an output.

    + +
    fun

    A function that takes the output value as an input and returns a modified value. The returned value will be used for the test snapshot.

    +
    @@ -77,7 +80,7 @@ modified value. The returned value will be used for the test snapshot.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/splitLayout.html b/reference/splitLayout.html index 1c9624619..80572fd04 100644 --- a/reference/splitLayout.html +++ b/reference/splitLayout.html @@ -63,14 +63,19 @@ equal parts (by default).

    ...

    Unnamed arguments will become child elements of the layout. Named arguments will become HTML attributes on the outermost tag.

    + +
    cellWidths

    Character or numeric vector indicating the widths of the individual cells. Recycling will be used if needed. Character values will be interpreted as CSS lengths (see validateCssUnit()), numeric values as pixels.

    + +
    cellArgs

    Any additional attributes that should be used for each cell of the layout.

    +

    See also

    @@ -137,7 +142,7 @@ of the layout.

    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/stacktrace.html b/reference/stacktrace.html index 89fc50f7f..1beefc5e5 100644 --- a/reference/stacktrace.html +++ b/reference/stacktrace.html @@ -88,10 +88,14 @@ manipulating stack traces.

    Arguments

    expr

    The expression to wrap.

    + +
    full

    If TRUE, then every element of sys.calls() will be included in the stack trace. By default (FALSE), calls that Shiny deems uninteresting will be hidden.

    + +
    offset

    If TRUE (the default), srcrefs will be reassigned from the calls they originated from, to the destinations of those calls. If @@ -99,15 +103,22 @@ you're used to stack traces from other languages, this feels more intuitive, as the definition of the function indicated in the call and the location specified by the srcref match up. If FALSE, srcrefs will be left alone (traditional R treatment where the srcref is of the callsite).

    + +
    cond

    A condition that may have previously been annotated by captureStackTraces (or withLogErrors).

    + +
    value

    The stack trace value to assign to the condition.

    +

    Value

    -

    printError and printStackTrace return + + +

    printError and printStackTrace return invisible(). The other functions pass through the results of expr.

    @@ -215,7 +226,7 @@ value is less than 1 is hidden, and finally, the ..stacktraceon.. and
    -

    Site built with pkgdown 2.0.3.

    +

    Site built with pkgdown 2.0.4.

    diff --git a/reference/stopApp.html b/reference/stopApp.html index 0a1451441..a07768e3d 100644 --- a/reference/stopApp.html +++ b/reference/stopApp.html @@ -63,6 +63,7 @@ runApp().">