mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
Built site for shiny: 1.7.1.9003@8a5da25
This commit is contained in:
cpsievert
2
404.html
2
404.html
@@ -95,7 +95,7 @@ Content not found. Please use links in the navbar.
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p>
|
||||
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
@@ -89,7 +89,7 @@
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -1077,7 +1077,7 @@ Public License instead of this License.
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -155,7 +155,7 @@
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 9.8 KiB After Width: | Height: | Size: 9.8 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.3 KiB After Width: | Height: | Size: 4.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 5.7 KiB After Width: | Height: | Size: 5.7 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
@@ -220,7 +220,7 @@ R package version 1.7.1.9003, <a href="https://shiny.rstudio.com/" class="extern
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.1 KiB After Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 2.1 KiB After Width: | Height: | Size: 2.1 KiB |
@@ -210,7 +210,7 @@
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p>
|
||||
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
|
||||
@@ -76,7 +76,6 @@
|
||||
<li><p>Closed <a href="https://github.com/rstudio/shiny/issues/3397" class="external-link">#3397</a>: <code><a href="../reference/renderPlot.html">renderPlot()</a></code> new uses <code><a href="https://ggplot2.tidyverse.org/reference/get_alt_text.html" class="external-link">ggplot2::get_alt_text()</a></code> to inform an <code>alt</code> text default (for <a href="https://ggplot2.tidyverse.org" class="external-link">ggplot2</a> plots). (<a href="https://github.com/rstudio/shiny/issues/3398" class="external-link">#3398</a>)</p></li>
|
||||
<li><p><code><a href="../reference/modalDialog.html">modalDialog()</a></code> gains support for <code>size = "xl"</code>. (<a href="https://github.com/rstudio/shiny/issues/3410" class="external-link">#3410</a>)</p></li>
|
||||
<li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/2521" class="external-link">#2521</a>: 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. (<a href="https://github.com/rstudio/shiny/issues/3456" class="external-link">#3456</a>)</p></li>
|
||||
<li><p><code><a href="../reference/fileInput.html">fileInput()</a></code> can set the <code>capture</code> attribute to facilitates user access to a device’s media capture mechanism, such as a camera, or microphone, from within a file upload control (<a href="https://www.w3.org/TR/html-media-capture/" class="external-link">W3C HTML Media Capture</a>). (Thanks to khaled-alshamaa, <a href="https://github.com/rstudio/shiny/issues/3481" class="external-link">#3481</a>)</p></li>
|
||||
</ul></div>
|
||||
<div class="section level4">
|
||||
<h4 id="other-improvements-1-7-0">Other improvements<a class="anchor" aria-label="anchor" href="#other-improvements-1-7-0"></a></h4>
|
||||
@@ -88,7 +87,7 @@
|
||||
<div class="section level4">
|
||||
<h4 id="bug-fixes-1-7-0">Bug fixes<a class="anchor" aria-label="anchor" href="#bug-fixes-1-7-0"></a></h4>
|
||||
<ul><li><p>Closed <a href="https://github.com/rstudio/shiny/issues/3345" class="external-link">#3345</a>: Shiny now correctly renders <code><a href="https://rdrr.io/pkg/htmltools/man/htmlDependency.html" class="external-link">htmltools::htmlDependency()</a></code>(s) with a <code><a href="https://rdrr.io/r/base/list.html" class="external-link">list()</a></code> of <code>script</code> attributes when used in a dynamic UI context. This fairly new <code>htmlDependency()</code> feature was added in <a href="https://github.com/rstudio/htmltools" class="external-link">htmltools</a> v0.5.1. (<a href="https://github.com/rstudio/shiny/issues/3395" class="external-link">#3395</a>)</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/2666" class="external-link">#2666</a> and <a href="https://github.com/rstudio/shiny/issues/2670" class="external-link">#2670</a>: <code><a href="../reference/brushedPoints.html">nearPoints()</a></code> and <code><a href="../reference/brushedPoints.html">brushedPoints()</a></code> weren’t properly account for missing values (<a href="https://github.com/rstudio/shiny/issues/2666" class="external-link">#2666</a> was introduced in v1.4.0). (<a href="https://github.com/rstudio/shiny/pull/2668" class="external-link">#2668</a>)</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/2666" class="external-link"></a><a href="https://github.com/rstudio/shiny/issues/2666" class="external-link">#2666</a> and <a href="https://github.com/rstudio/shiny/issues/2670" class="external-link"></a><a href="https://github.com/rstudio/shiny/issues/2670" class="external-link">#2670</a>: <code><a href="../reference/brushedPoints.html">nearPoints()</a></code> and <code><a href="../reference/brushedPoints.html">brushedPoints()</a></code> weren’t properly account for missing values (<a href="https://github.com/rstudio/shiny/issues/2666" class="external-link">#2666</a> was introduced in v1.4.0). (<a href="https://github.com/rstudio/shiny/pull/2668" class="external-link"></a><a href="https://github.com/rstudio/shiny/issues/2668" class="external-link">#2668</a>)</p></li>
|
||||
<li><p>Closed <a href="https://github.com/rstudio/shiny/issues/3374" class="external-link">#3374</a>: <code><a href="../reference/createRenderFunction.html">quoToFunction()</a></code> now works correctly with nested quosures; and as a result, quasi-quotation with rendering function (e.g., <code><a href="../reference/renderPrint.html">renderPrint()</a></code>, <code><a href="../reference/renderPlot.html">renderPlot()</a></code>, etc) now works as expected with nested quosures. (<a href="https://github.com/rstudio/shiny/issues/3373" class="external-link">#3373</a>)</p></li>
|
||||
<li><p>Exported <code><a href="../reference/devmode.html">register_devmode_option()</a></code>. This method was described in the documentation for <code><a href="../reference/devmode.html">devmode()</a></code> but was never exported. See <code>?devmode()</code> for more details on how to register Shiny Developer options using <code><a href="../reference/devmode.html">register_devmode_option()</a></code>. (<a href="https://github.com/rstudio/shiny/issues/3364" class="external-link">#3364</a>)</p></li>
|
||||
<li><p>Closed <a href="https://github.com/rstudio/shiny/issues/3484" class="external-link">#3484</a>: In the RStudio IDE on Mac 11.5, selected checkboxes and radio buttons were not visible. (<a href="https://github.com/rstudio/shiny/issues/3485" class="external-link">#3485</a>)</p></li>
|
||||
@@ -182,7 +181,7 @@
|
||||
<h4 id="new-features-1-5-0">New features<a class="anchor" aria-label="anchor" href="#new-features-1-5-0"></a></h4>
|
||||
<ul><li><p>The new <code><a href="../reference/shinyAppTemplate.html">shinyAppTemplate()</a></code> 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. (<a href="https://github.com/rstudio/shiny/issues/2704" class="external-link">#2704</a>)</p></li>
|
||||
<li><p><code><a href="../reference/runTests.html">runTests()</a></code> is a new function that behaves much like R CMD check. <code><a href="../reference/runTests.html">runTests()</a></code> invokes all of the top-level R files in the tests/ directory inside an application, in that application’s environment. (<a href="https://github.com/rstudio/shiny/issues/2585" class="external-link">#2585</a>)</p></li>
|
||||
<li><p><code><a href="../reference/testServer.html">testServer()</a></code> is a new function for testing reactive behavior inside server functions and modules. (<a href="https://github.com/rstudio/shiny/pull/2682" class="external-link">#2682</a>, <a href="https://github.com/rstudio/shiny/pull/2764" class="external-link">#2764</a>, <a href="https://github.com/rstudio/shiny/pull/2807" class="external-link">#2807</a>)</p></li>
|
||||
<li><p><code><a href="../reference/testServer.html">testServer()</a></code> is a new function for testing reactive behavior inside server functions and modules. (<a href="https://github.com/rstudio/shiny/pull/2682" class="external-link"></a><a href="https://github.com/rstudio/shiny/issues/2682" class="external-link">#2682</a>, <a href="https://github.com/rstudio/shiny/pull/2764" class="external-link"></a><a href="https://github.com/rstudio/shiny/issues/2764" class="external-link">#2764</a>, <a href="https://github.com/rstudio/shiny/pull/2807" class="external-link"></a><a href="https://github.com/rstudio/shiny/issues/2807" class="external-link">#2807</a>)</p></li>
|
||||
<li><p>The new <code>moduleServer</code> function provides a simpler interface for creating and using modules. (<a href="https://github.com/rstudio/shiny/issues/2773" class="external-link">#2773</a>)</p></li>
|
||||
<li><p>Resolved <a href="https://github.com/rstudio/shiny/issues/2732" class="external-link">#2732</a>: <code><a href="../reference/markdown.html">markdown()</a></code> is a new function for writing Markdown with Github extensions directly in Shiny UIs. Markdown rendering is performed by the <a href="https://github.com/r-lib/commonmark" class="external-link">commonmark</a> package. (<a href="https://github.com/rstudio/shiny/issues/2737" class="external-link">#2737</a>)</p></li>
|
||||
<li><p>The <code><a href="../reference/getCurrentOutputInfo.html">getCurrentOutputInfo()</a></code> function can now return the background color (<code>bg</code>), foreground color (<code>fg</code>), <code>accent</code> (i.e., hyperlink) color, and <code>font</code> information of the output’s HTML container. This information is reported by <code><a href="../reference/plotOutput.html">plotOutput()</a></code>, <code><a href="../reference/plotOutput.html">imageOutput()</a></code>, and any other output bindings containing a class of <code>.shiny-report-theme</code>. This feature allows developers to style an output’s contents based on the container’s CSS styling. (<a href="https://github.com/rstudio/shiny/issues/2740" class="external-link">#2740</a>)</p></li>
|
||||
@@ -365,9 +364,9 @@
|
||||
<li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/1851" class="external-link">#1851</a>: Stack traces are now smaller in some places <code><a href="https://rdrr.io/r/base/do.call.html" class="external-link">do.call()</a></code> is used. (<a href="https://github.com/rstudio/shiny/issues/1856" class="external-link">#1856</a>)</p></li>
|
||||
<li><p>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).</p></li>
|
||||
<li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/1859" class="external-link">#1859</a>: Server-side selectize is now significantly faster. (Thanks to <a href="https://github.com/dselivanov" class="external-link">@dselivanov</a> <a href="https://github.com/rstudio/shiny/issues/1861" class="external-link">#1861</a>)</p></li>
|
||||
<li><p>#1989: The server side of outputs can now be removed (e.g. <code>output$plot <- NULL</code>). 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, <a href="https://github.com/mmuurr" class="external-link">@mmuurr</a>! <a href="https://github.com/rstudio/shiny/issues/2011" class="external-link">#2011</a>)</p></li>
|
||||
<li><p><a href="https://github.com/rstudio/shiny/issues/1989" class="external-link">#1989</a>: The server side of outputs can now be removed (e.g. <code>output$plot <- NULL</code>). 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, <a href="https://github.com/mmuurr" class="external-link">@mmuurr</a>! <a href="https://github.com/rstudio/shiny/issues/2011" class="external-link">#2011</a>)</p></li>
|
||||
<li><p>Removed the (ridiculously outdated) “experimental feature” tag from the reference documentation for <code>renderUI</code>. (<a href="https://github.com/rstudio/shiny/issues/2036" class="external-link">#2036</a>)</p></li>
|
||||
<li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/1907" class="external-link">#1907</a>: the <code>ignoreInit</code> argument was first added only to <code>observeEvent</code>. Later, we also added it to <code>eventReactive</code>, but forgot to update the documentation. Now done, thanks <a href="https://github.com/flo12392" class="external-link">@flo12392</a>! (<a href="https://github.com/rstudio/shiny/issues/2036" class="external-link">#2036</a>)</p></li>
|
||||
<li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/1907" class="external-link">#1907</a>: the <code>ignoreInit</code> argument was first added only to <code>observeEvent</code>. Later, we also added it to <code>eventReactive</code>, but forgot to update the documentation. Now done, thanks <a href="https://github.com/flo12392" class="external-link"></a><a href="https://github.com/flo12392" class="external-link">@flo12392</a>! (<a href="https://github.com/rstudio/shiny/issues/2036" class="external-link">#2036</a>)</p></li>
|
||||
</ul></div>
|
||||
<div class="section level4">
|
||||
<h4 id="bug-fixes-1-1-0">Bug fixes<a class="anchor" aria-label="anchor" href="#bug-fixes-1-1-0"></a></h4>
|
||||
@@ -417,7 +416,7 @@
|
||||
</ul></div>
|
||||
<div class="section level4">
|
||||
<h4 id="minor-new-features-and-improvements-1-0-4">Minor new features and improvements<a class="anchor" aria-label="anchor" href="#minor-new-features-and-improvements-1-0-4"></a></h4>
|
||||
<ul><li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/1688" class="external-link">#1688</a>: trigger a new <code>shiny:outputinvalidated</code> event when an output gets invalidated, at the same time that the <code>recalculating</code> CSS class is added. (<a href="https://github.com/rstudio/shiny/issues/1758" class="external-link">#1758</a>, thanks <a href="https://github.com/andrewsali" class="external-link">@andrewsali</a>!)</p></li>
|
||||
<ul><li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/1688" class="external-link">#1688</a>: trigger a new <code>shiny:outputinvalidated</code> event when an output gets invalidated, at the same time that the <code>recalculating</code> CSS class is added. (<a href="https://github.com/rstudio/shiny/issues/1758" class="external-link">#1758</a>, thanks <a href="https://github.com/andrewsali" class="external-link"></a><a href="https://github.com/andrewsali" class="external-link">@andrewsali</a>!)</p></li>
|
||||
<li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/1508" class="external-link">#1508</a>: <code>fileInput</code> now permits the same file to be uploaded multiple times. (<a href="https://github.com/rstudio/shiny/issues/1719" class="external-link">#1719</a>)</p></li>
|
||||
<li><p>Addressed <a href="https://github.com/rstudio/shiny/issues/1501" class="external-link">#1501</a>: The <code>fileInput</code> control now retains uploaded file extensions on the server. This fixes <a href="https://github.com/tidyverse/readxl" class="external-link">readxl</a>’s <code>readxl::read_excel</code> and other functions that must recognize a file’s extension in order to work. (<a href="https://github.com/rstudio/shiny/issues/1706" class="external-link">#1706</a>)</p></li>
|
||||
<li><p>For <code>conditionalPanel</code>s, Shiny now gives more informative messages if there are errors evaluating or parsing the JavaScript conditional expression. (<a href="https://github.com/rstudio/shiny/issues/1727" class="external-link">#1727</a>)</p></li>
|
||||
@@ -705,8 +704,8 @@
|
||||
<li><p>Added support for horizontal dividers in <code>navbarMenu</code>. (<a href="https://github.com/rstudio/shiny/issues/1147" class="external-link">#1147</a>)</p></li>
|
||||
<li><p>Added <code>placeholder</code> option to <code>passwordInput</code>. (<a href="https://github.com/rstudio/shiny/issues/1152" class="external-link">#1152</a>)</p></li>
|
||||
<li><p>Added <code>session$resetBrush(brushId)</code> (R) and <code>Shiny.resetBrush(brushId)</code> (JS) to programatically clear brushes from <code>imageOutput</code>/<code>plotOutput</code>. (<a href="https://github.com/rstudio/shiny/issues/1197" class="external-link">#1197</a>)</p></li>
|
||||
<li><p>Added textAreaInput. (thanks, <a href="https://github.com/nuno-agostinho" class="external-link">@nuno-agostinho</a>! <a href="https://github.com/rstudio/shiny/issues/1300" class="external-link">#1300</a>)</p></li>
|
||||
<li><p>Added <code>session$sendBinaryMessage(type, message)</code> method for sending custom binary data to the client. See <code><a href="../reference/session.html">?session</a></code>. (thanks, <a href="https://github.com/daef" class="external-link">@daef</a>! <a href="https://github.com/rstudio/shiny/issues/1316" class="external-link">#1316</a> and <a href="https://github.com/rstudio/shiny/issues/1320" class="external-link">#1320</a>)</p></li>
|
||||
<li><p>Added textAreaInput. (thanks, <a href="https://github.com/nuno-agostinho" class="external-link"></a><a href="https://github.com/nuno-agostinho" class="external-link">@nuno-agostinho</a>! <a href="https://github.com/rstudio/shiny/issues/1300" class="external-link">#1300</a>)</p></li>
|
||||
<li><p>Added <code>session$sendBinaryMessage(type, message)</code> method for sending custom binary data to the client. See <code><a href="../reference/session.html">?session</a></code>. (thanks, <a href="https://github.com/daef" class="external-link"></a><a href="https://github.com/daef" class="external-link">@daef</a>! <a href="https://github.com/rstudio/shiny/issues/1316" class="external-link">#1316</a> and <a href="https://github.com/rstudio/shiny/issues/1320" class="external-link">#1320</a>)</p></li>
|
||||
<li><p>Almost all code examples now have a runnable example with <code><a href="../reference/shinyApp.html">shinyApp()</a></code>, so that users can run the examples and see them in action. (<a href="https://github.com/rstudio/shiny/issues/1158" class="external-link">#1158</a>)</p></li>
|
||||
<li><p>When resized, plots are drawn with <code><a href="https://rdrr.io/r/grDevices/recordplot.html" class="external-link">replayPlot()</a></code>, instead of re-executing all plotting code. This results in faster plot rendering. (<a href="https://github.com/rstudio/shiny/issues/1112" class="external-link">#1112</a>)</p></li>
|
||||
<li><p>Exported the <code><a href="../reference/isTruthy.html">isTruthy()</a></code> function. (part of PR <a href="https://github.com/rstudio/shiny/issues/1272" class="external-link">#1272</a>)</p></li>
|
||||
@@ -717,14 +716,14 @@
|
||||
<h4 id="bug-fixes-0-14">Bug fixes<a class="anchor" aria-label="anchor" href="#bug-fixes-0-14"></a></h4>
|
||||
<ul><li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/1350" class="external-link">#1350</a>: Highlighting of reactives didn’t work in showcase mode.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/1331" class="external-link">#1331</a>: <code><a href="../reference/renderPlot.html">renderPlot()</a></code> now correctly records and replays plots when <code>execOnResize = FALSE</code>.</p></li>
|
||||
<li><p><code><a href="../reference/updateDateInput.html">updateDateInput()</a></code> and <code><a href="../reference/updateDateRangeInput.html">updateDateRangeInput()</a></code> can now clear the date input fields. (thanks, <a href="https://github.com/gaborcsardi" class="external-link">@gaborcsardi</a>! <a href="https://github.com/rstudio/shiny/issues/1299" class="external-link">#1299</a>, <a href="https://github.com/rstudio/shiny/issues/1315" class="external-link">#1315</a> and <a href="https://github.com/rstudio/shiny/issues/1317" class="external-link">#1317</a>)</p></li>
|
||||
<li><p><code><a href="../reference/updateDateInput.html">updateDateInput()</a></code> and <code><a href="../reference/updateDateRangeInput.html">updateDateRangeInput()</a></code> can now clear the date input fields. (thanks, <a href="https://github.com/gaborcsardi" class="external-link"></a><a href="https://github.com/gaborcsardi" class="external-link">@gaborcsardi</a>! <a href="https://github.com/rstudio/shiny/issues/1299" class="external-link">#1299</a>, <a href="https://github.com/rstudio/shiny/issues/1315" class="external-link">#1315</a> and <a href="https://github.com/rstudio/shiny/issues/1317" class="external-link">#1317</a>)</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/561" class="external-link">#561</a>: DataTables previously might pop up a warning when the data was updated extremely frequently.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/776" class="external-link">#776</a>: In some browsers, plots sometimes flickered when updated.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/543" class="external-link">#543</a> and <a href="https://github.com/rstudio/shiny/issues/855" class="external-link">#855</a>: When <code><a href="../reference/navbarPage.html">navbarPage()</a></code> had a <code><a href="../reference/navbarPage.html">navbarMenu()</a></code> as the first item, it did not automatically select an item.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/970" class="external-link">#970</a>: <code><a href="../reference/navbarPage.html">navbarPage()</a></code> previously did not have an option to set the selected tab.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/1253" class="external-link">#1253</a>: Memory could leak when an observer was destroyed without first being invalidated.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/931" class="external-link">#931</a>: Nested observers could leak memory.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/1144" class="external-link">#1144</a>: <code>updateRadioButton()</code> and <code><a href="../reference/updateCheckboxGroupInput.html">updateCheckboxGroupInput()</a></code> broke controls when used in modules (thanks, <a href="https://github.com/sipemu" class="external-link">@sipemu</a>!).</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/1144" class="external-link">#1144</a>: <code>updateRadioButton()</code> and <code><a href="../reference/updateCheckboxGroupInput.html">updateCheckboxGroupInput()</a></code> broke controls when used in modules (thanks, <a href="https://github.com/sipemu" class="external-link"></a><a href="https://github.com/sipemu" class="external-link">@sipemu</a>!).</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/1093" class="external-link">#1093</a>: <code><a href="../reference/updateRadioButtons.html">updateRadioButtons()</a></code> and <code><a href="../reference/updateCheckboxGroupInput.html">updateCheckboxGroupInput()</a></code> didn’t work if <code>choices</code> was numeric vector.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/1122" class="external-link">#1122</a>: <code><a href="../reference/downloadHandler.html">downloadHandler()</a></code> popped up empty browser window if the file wasn’t present. It now gives a 404 error code.</p></li>
|
||||
<li><p>Fixed <a href="https://github.com/rstudio/shiny/issues/1278" class="external-link">#1278</a>: Reactive system was being flushed too often (usually this just means a more-expensive no-op than necessary).</p></li>
|
||||
@@ -1193,7 +1192,7 @@
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -734,7 +734,7 @@ output, or <code>NULL</code> if no output is currently executing.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -74,12 +74,17 @@ any length, though a single element is most common. Length 0 will cause the
|
||||
<code>id</code> 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).</p></dd>
|
||||
|
||||
|
||||
<dt>id</dt>
|
||||
<dd><p>The id string to be namespaced (optional).</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>If <code>id</code> is missing, returns a function that expects an id string
|
||||
|
||||
|
||||
<p>If <code>id</code> is missing, returns a function that expects an id string
|
||||
as its only argument and returns that id with the namespace prepended.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
@@ -108,7 +113,7 @@ into a namespaced one, by combining them with <code>ns.sep</code> in between.</p
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -287,7 +287,7 @@ relative to <code>message</code>.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -84,28 +84,46 @@
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>Attributes (named arguments) or children (unnamed arguments) that
|
||||
should be included in the panel.</p></dd>
|
||||
|
||||
|
||||
<dt>top</dt>
|
||||
<dd><p>Distance between the top of the panel, and the top of the page or
|
||||
parent container.</p></dd>
|
||||
|
||||
|
||||
<dt>left</dt>
|
||||
<dd><p>Distance between the left side of the panel, and the left of the
|
||||
page or parent container.</p></dd>
|
||||
|
||||
|
||||
<dt>right</dt>
|
||||
<dd><p>Distance between the right side of the panel, and the right of
|
||||
the page or parent container.</p></dd>
|
||||
|
||||
|
||||
<dt>bottom</dt>
|
||||
<dd><p>Distance between the bottom of the panel, and the bottom of the
|
||||
page or parent container.</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>Width of the panel.</p></dd>
|
||||
|
||||
|
||||
<dt>height</dt>
|
||||
<dd><p>Height of the panel.</p></dd>
|
||||
|
||||
|
||||
<dt>draggable</dt>
|
||||
<dd><p>If <code>TRUE</code>, allows the user to move the panel by
|
||||
clicking and dragging.</p></dd>
|
||||
|
||||
|
||||
<dt>fixed</dt>
|
||||
<dd><p>Positions the panel relative to the browser window and prevents
|
||||
it from being scrolled with the rest of the page.</p></dd>
|
||||
|
||||
|
||||
<dt>cursor</dt>
|
||||
<dd><p>The type of cursor that should appear when the user mouses over
|
||||
the panel. Use <code>"move"</code> for a north-east-south-west icon,
|
||||
@@ -113,10 +131,13 @@ the panel. Use <code>"move"</code> 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 <code>"auto"</code>, which is equivalent to
|
||||
<code>ifelse(draggable, "move", "inherit")</code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>An HTML element or list of elements.</p>
|
||||
|
||||
|
||||
<p>An HTML element or list of elements.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -155,7 +176,7 @@ rather than the more obvious <code>width = "100%"</code> and <code>height = "100
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -64,16 +64,25 @@ each time it is pressed.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>The contents of the button or link--usually a text label, but
|
||||
you could also use any other HTML, like an image.</p></dd>
|
||||
|
||||
|
||||
<dt>icon</dt>
|
||||
<dd><p>An optional <code><a href="icon.html">icon()</a></code> to appear on the button.</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Named attributes to be applied to the button or link.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="server-value">
|
||||
<h2>Server value</h2>
|
||||
@@ -151,7 +160,7 @@ This implies two things:</p><ul><li><p>Event handlers (e.g., <code><a href="obse
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -66,8 +66,11 @@ values.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputs</dt>
|
||||
<dd><p>A named list of input values.</p></dd>
|
||||
|
||||
|
||||
<dt>shinysession</dt>
|
||||
<dd><p>A Shiny session object.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -93,7 +96,7 @@ output.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -72,12 +72,17 @@ cache) and they can be shared across user sessions. This allows
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>x</dt>
|
||||
<dd><p>The object to add caching to.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>One or more expressions to use in the caching key.</p></dd>
|
||||
|
||||
|
||||
<dt>cache</dt>
|
||||
<dd><p>The scope of the cache, or a cache object. This can be <code>"app"</code>
|
||||
(the default), <code>"session"</code>, or a cache object like a
|
||||
<code><a href="https://cachem.r-lib.org/reference/cache_disk.html" class="external-link">cachem::cache_disk()</a></code>. See the Cache Scoping section for more information.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -192,18 +197,21 @@ persists beyond the current R session.</p>
|
||||
<code><a href="shinyOptions.html">shinyOptions()</a></code> 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:</p>
|
||||
<p></p><div class="sourceCode"><pre><code></code></pre><p></p></div>
|
||||
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1"></a><span class="kw">shinyOptions</span>(<span class="dt">cache =</span> cachem<span class="op">::</span><span class="kw">cache_mem</span>(<span class="dt">max_size =</span> <span class="fl">500e6</span>))</span></code></pre><p></p></div>
|
||||
<p>To use different settings for a session-scoped cache, you can set
|
||||
<code>self$cache</code> 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
|
||||
<code>bindCache()</code> with <code>cache="session"</code>. This will create a 100 MB cache for
|
||||
the session:</p>
|
||||
<p></p><div class="sourceCode"><pre><code></code></pre><p></p></div>
|
||||
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1"></a><span class="cf">function</span>(input, output, session) {</span>
|
||||
<span id="cb1-2"><a href="#cb1-2"></a> session<span class="op">$</span>cache <-<span class="st"> </span>cachem<span class="op">::</span><span class="kw">cache_mem</span>(<span class="dt">max_size =</span> <span class="fl">100e6</span>)</span>
|
||||
<span id="cb1-3"><a href="#cb1-3"></a> ...</span>
|
||||
<span id="cb1-4"><a href="#cb1-4"></a>}</span></code></pre><p></p></div>
|
||||
<p>If you want to use a cache that is shared across multiple R processes, you
|
||||
can use a <code><a href="https://cachem.r-lib.org/reference/cache_disk.html" class="external-link">cachem::cache_disk()</a></code>. You can create a application-level shared
|
||||
cache by putting this at the top of your app.R, server.R, or global.R:</p>
|
||||
<p></p><div class="sourceCode"><pre><code></code></pre><p></p></div>
|
||||
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1"></a><span class="kw">shinyOptions</span>(<span class="dt">cache =</span> cachem<span class="op">::</span><span class="kw">cache_disk</span>(<span class="kw">file.path</span>(<span class="kw">dirname</span>(<span class="kw">tempdir</span>()), <span class="st">"myapp-cache"</span>))</span></code></pre><p></p></div>
|
||||
<p>This will create a subdirectory in your system temp directory named
|
||||
<code>myapp-cache</code> (replace <code>myapp-cache</code> 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.</p>
|
||||
<p>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:</p>
|
||||
<p></p><div class="sourceCode"><pre><code></code></pre><p></p></div>
|
||||
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1"></a><span class="kw">shinyOptions</span>(<span class="dt">cache =</span> cachem<span class="op">::</span><span class="kw">cache_disk</span>(<span class="st">"./myapp-cache"</span>))</span></code></pre><p></p></div>
|
||||
<p>In this case, resetting the cache will have to be done manually, by deleting
|
||||
the directory.</p>
|
||||
<p>You can also scope a cache to just one item, or selected items. To do that,
|
||||
@@ -273,7 +281,8 @@ the cache.</p>
|
||||
<code><a href="https://rdrr.io/pkg/htmlwidgets/man/htmlwidgets-shiny.html" class="external-link">htmlwidgets::shinyRenderWidget()</a></code>, if you've authored an htmlwidget) in
|
||||
order for <code>bindCache()</code> to correctly compute a cache key.</p>
|
||||
<p>The potential problem is a cache collision. Consider the following:</p>
|
||||
<p></p><div class="sourceCode"><pre><code></code></pre><p></p></div>
|
||||
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1"></a>output<span class="op">$</span>x1 <-<span class="st"> </span><span class="kw">renderText</span>({ input<span class="op">$</span>x }) <span class="op">%>%</span><span class="st"> </span><span class="kw">bindCache</span>(input<span class="op">$</span>x)</span>
|
||||
<span id="cb1-2"><a href="#cb1-2"></a>output<span class="op">$</span>x2 <-<span class="st"> </span><span class="kw">renderText</span>({ input<span class="op">$</span>x <span class="op">*</span><span class="st"> </span><span class="dv">2</span> }) <span class="op">%>%</span><span class="st"> </span><span class="kw">bindCache</span>(input<span class="op">$</span>x)</span></code></pre><p></p></div>
|
||||
<p>Both <code>output$x1</code> and <code>output$x2</code> use <code>input$x</code> 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.</p>
|
||||
again, you can inspect the cache hint with <code>shiny:::extractCacheHint()</code> and
|
||||
also test it in an application. If you do need to explicitly provide a
|
||||
cache hint, pass it to <code>shinyRenderWidget</code>. For example:</p>
|
||||
<p></p><div class="sourceCode"><pre><code></code></pre><p></p></div>
|
||||
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1"></a>renderMyWidget <-<span class="st"> </span><span class="cf">function</span>(expr) {</span>
|
||||
<span id="cb1-2"><a href="#cb1-2"></a> q <-<span class="st"> </span>rlang<span class="op">::</span><span class="kw">enquo0</span>(expr)</span>
|
||||
<span id="cb1-3"><a href="#cb1-3"></a></span>
|
||||
<span id="cb1-4"><a href="#cb1-4"></a> htmlwidgets<span class="op">::</span><span class="kw">shinyRenderWidget</span>(</span>
|
||||
<span id="cb1-5"><a href="#cb1-5"></a> q,</span>
|
||||
<span id="cb1-6"><a href="#cb1-6"></a> myWidgetOutput,</span>
|
||||
<span id="cb1-7"><a href="#cb1-7"></a> <span class="dt">quoted =</span> <span class="ot">TRUE</span>,</span>
|
||||
<span id="cb1-8"><a href="#cb1-8"></a> <span class="dt">cacheHint =</span> <span class="kw">list</span>(<span class="dt">label =</span> <span class="st">"myWidget"</span>, <span class="dt">userQuo =</span> q)</span>
|
||||
<span id="cb1-9"><a href="#cb1-9"></a> )</span>
|
||||
<span id="cb1-10"><a href="#cb1-10"></a>}</span></code></pre><p></p></div>
|
||||
<p>If your <code>render</code> function sets any internal state, you may find it useful
|
||||
in your call to <code><a href="createRenderFunction.html">createRenderFunction()</a></code> to use
|
||||
the <code>cacheWriteHook</code> and/or <code>cacheReadHook</code> parameters. These hooks are
|
||||
@@ -339,7 +357,7 @@ in order to work properly.</p>
|
||||
<p>When <code>bindCache()</code> is used with <code><a href="renderPlot.html">renderPlot()</a></code>, the <code>height</code> and <code>width</code>
|
||||
passed to the original <code><a href="renderPlot.html">renderPlot()</a></code> are ignored. They are superseded by
|
||||
<code>sizePolicy</code> argument passed to `bindCache. The default is:</p>
|
||||
<p></p><div class="sourceCode"><pre><code></code></pre><p></p></div>
|
||||
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1"></a>sizePolicy =<span class="st"> </span><span class="kw">sizeGrowthRatio</span>(<span class="dt">width =</span> <span class="dv">400</span>, <span class="dt">height =</span> <span class="dv">400</span>, <span class="dt">growthRate =</span> <span class="fl">1.2</span>)</span></code></pre><p></p></div>
|
||||
<p><code>sizePolicy</code> must be a function that takes a two-element numeric vector as
|
||||
input, representing the width and height of the <code><img></code> element in the
|
||||
browser window, and it must return a two-element numeric vector, representing
|
||||
@@ -461,7 +479,7 @@ See <code><a href="sizeGrowthRatio.html">sizeGrowthRatio()</a></code> for more i
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -86,26 +86,37 @@ with <code><a href="bindCache.html">bindCache()</a></code>, and it can also be u
|
||||
<dl><dt>x</dt>
|
||||
<dd><p>An object to wrap so that is triggered only when a the specified
|
||||
event occurs.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>One or more expressions that represents the event; this can be a
|
||||
simple reactive value like <code>input$click</code>, a call to a reactive expression
|
||||
like <code>dataset()</code>, or even a complex expression inside curly braces. If
|
||||
there are multiple expressions in the <code>...</code>, then it will take a dependency
|
||||
on all of them.</p></dd>
|
||||
|
||||
|
||||
<dt>ignoreNULL</dt>
|
||||
<dd><p>Whether the action should be triggered (or value
|
||||
calculated) when the input is <code>NULL</code>. See Details.</p></dd>
|
||||
|
||||
|
||||
<dt>ignoreInit</dt>
|
||||
<dd><p>If <code>TRUE</code>, then, when the eventified object is first
|
||||
created/initialized, don't trigger the action or (compute the value). The
|
||||
default is <code>FALSE</code>. See Details.</p></dd>
|
||||
|
||||
|
||||
<dt>once</dt>
|
||||
<dd><p>Used only for observers. Whether this <code>observer</code> 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.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>A label for the observer or reactive, useful for debugging.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -240,7 +251,7 @@ expression given to <code>bindEvent()</code>, and not the cache key expression g
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -71,19 +71,28 @@ used for bookmarking state.</p>
|
||||
<dl><dt>label</dt>
|
||||
<dd><p>The contents of the button or link--usually a text label, but
|
||||
you could also use any other HTML, like an image.</p></dd>
|
||||
|
||||
|
||||
<dt>icon</dt>
|
||||
<dd><p>An optional <code><a href="icon.html">icon()</a></code> to appear on the button.</p></dd>
|
||||
|
||||
|
||||
<dt>title</dt>
|
||||
<dd><p>A tooltip that is shown when the mouse cursor hovers over the
|
||||
button.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Named attributes to be applied to the button or link.</p></dd>
|
||||
|
||||
|
||||
<dt>id</dt>
|
||||
<dd><p>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
|
||||
<code><a href="setBookmarkExclude.html">setBookmarkExclude()</a></code>, and you must create an observer that
|
||||
does the bookmarking when the button is pressed. See the examples below.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -140,7 +149,7 @@ does the bookmarking when the button is pressed. See the examples below.</p></dd
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -67,6 +67,7 @@ build of Bootstrap 3 with a customized version of Bootstrap 3 or higher.</p></li
|
||||
<li><p>A character string pointing to an alternative Bootstrap stylesheet
|
||||
(normally a css file within the www directory, e.g. <code>www/bootstrap.css</code>).</p></li>
|
||||
</ul></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -87,7 +88,7 @@ others which use <code>bootstrapPage</code>, such <code><a href="fluidPage.html"
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -66,8 +66,12 @@ body (other than what you provide).</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>The contents of the document body.</p></dd>
|
||||
|
||||
|
||||
<dt>title</dt>
|
||||
<dd><p>The browser window title (defaults to the host URL of the page)</p></dd>
|
||||
|
||||
|
||||
<dt>theme</dt>
|
||||
<dd><p>One of the following:</p><ul><li><p><code>NULL</code> (the default), which implies a "stock" build of Bootstrap 3.</p></li>
|
||||
<li><p>A <code><a href="https://rstudio.github.io/bslib/reference/bs_theme.html" class="external-link">bslib::bs_theme()</a></code> 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.</p></li
|
||||
<li><p>A character string pointing to an alternative Bootstrap stylesheet
|
||||
(normally a css file within the www directory, e.g. <code>www/bootstrap.css</code>).</p></li>
|
||||
</ul></dd>
|
||||
|
||||
|
||||
<dt>lang</dt>
|
||||
<dd><p>ISO 639-1 language code for the HTML page, such as "en" or "ko".
|
||||
This will be used as the lang in the <code><html></code> tag, as in <code><html lang="en"></code>.
|
||||
The default (NULL) results in an empty string.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function.</p>
|
||||
|
||||
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -113,7 +122,7 @@ and know how to lay out pages in Bootstrap. Most applications should use
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -78,39 +78,56 @@ then the coordinates will be available as <code>input$plot_brush</code>. Multipl
|
||||
<code>imageOutput</code>/<code>plotOutput</code> calls may share the same <code>id</code>
|
||||
value; brushing one image or plot will cause any other brushes with the
|
||||
same <code>id</code> to disappear.</p></dd>
|
||||
|
||||
|
||||
<dt>fill</dt>
|
||||
<dd><p>Fill color of the brush. If <code>'auto'</code>, it derives from the link
|
||||
color of the plot's HTML container (if <strong>thematic</strong> is enabled, and <code>accent</code>
|
||||
is a non-<code>'auto'</code> value, that color is used instead).</p></dd>
|
||||
|
||||
|
||||
<dt>stroke</dt>
|
||||
<dd><p>Outline color of the brush. If <code>'auto'</code>, it derives from the
|
||||
foreground color of the plot's HTML container (if <strong>thematic</strong> is enabled,
|
||||
and <code>fg</code> is a non-<code>'auto'</code> value, that color is used instead).</p></dd>
|
||||
|
||||
|
||||
<dt>opacity</dt>
|
||||
<dd><p>Opacity of the brush</p></dd>
|
||||
|
||||
|
||||
<dt>delay</dt>
|
||||
<dd><p>How long to delay (in milliseconds) when debouncing or
|
||||
throttling, before sending the brush data to the server.</p></dd>
|
||||
|
||||
|
||||
<dt>delayType</dt>
|
||||
<dd><p>The type of algorithm for limiting the number of brush
|
||||
events. Use <code>"throttle"</code> to limit the number of brush events to one
|
||||
every <code>delay</code> milliseconds. Use <code>"debounce"</code> to suspend events
|
||||
while the cursor is moving, and wait until the cursor has been at rest for
|
||||
<code>delay</code> milliseconds before sending an event.</p></dd>
|
||||
|
||||
|
||||
<dt>clip</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>direction</dt>
|
||||
<dd><p>The direction for brushing. If <code>"xy"</code>, the brush can be
|
||||
drawn and moved in both x and y directions. If <code>"x"</code>, or <code>"y"</code>,
|
||||
the brush wil work horizontally or vertically.</p></dd>
|
||||
|
||||
|
||||
<dt>resetOnNew</dt>
|
||||
<dd><p>When a new image is sent to the browser (via
|
||||
<code><a href="renderImage.html">renderImage()</a></code>), should the brush be reset? The default,
|
||||
<code>FALSE</code>, is useful if you want to update the plot while keeping the
|
||||
brush. Using <code>TRUE</code> is useful if you want to clear the brush whenever
|
||||
the plot is updated.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -129,7 +146,7 @@ the plot is updated.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -89,39 +89,58 @@ rows of the would be selected.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>df</dt>
|
||||
<dd><p>A data frame from which to select rows.</p></dd>
|
||||
|
||||
|
||||
<dt>brush, coordinfo</dt>
|
||||
<dd><p>The data from a brush or click/dblclick/hover event
|
||||
e.g. <code>input$plot_brush</code>, <code>input$plot_click</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>xvar, yvar</dt>
|
||||
<dd><p>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 <code>df</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>panelvar1, panelvar2</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>allRows</dt>
|
||||
<dd><p>If <code>FALSE</code> (the default) return a data frame containing
|
||||
the selected rows. If <code>TRUE</code>, the input data frame will have a new
|
||||
column, <code>selected_</code>, which indicates whether the row was selected or not.</p></dd>
|
||||
|
||||
|
||||
<dt>threshold</dt>
|
||||
<dd><p>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 <code>threshold</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>maxpoints</dt>
|
||||
<dd><p>Maximum number of rows to return. If <code>NULL</code> (the default),
|
||||
will return all rows within the threshold distance.</p></dd>
|
||||
|
||||
|
||||
<dt>addDist</dt>
|
||||
<dd><p>If TRUE, add a column named <code>dist_</code> that contains the
|
||||
distance from the coordinate to the point, in pixels. When no pointer
|
||||
event has yet occurred, the value of <code>dist_</code> will be <code>NA</code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A data frame based on <code>df</code>, containing the observations selected by the
|
||||
|
||||
|
||||
<p>A data frame based on <code>df</code>, containing the observations selected by the
|
||||
brush or near the click event. For <code>nearPoints()</code>, the rows will be sorted
|
||||
by distance to the event.
|
||||
If <code>allRows = TRUE</code>, then all rows will returned, along with a new
|
||||
by distance to the event.</p>
|
||||
|
||||
|
||||
<p>If <code>allRows = TRUE</code>, then all rows will returned, along with a new
|
||||
<code>selected_</code> column that indicates whether or not the point was selected.
|
||||
The output from <code>nearPoints()</code> will no longer be sorted, but you can
|
||||
set <code>addDist = TRUE</code> to get an additional column that gives the pixel
|
||||
@@ -182,7 +201,7 @@ using just the x or y variable, whichever is appropriate.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -66,18 +66,27 @@ to understand, and modules created with <code>moduleServer</code> can be tested
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>module</dt>
|
||||
<dd><p>A Shiny module server function</p></dd>
|
||||
|
||||
|
||||
<dt>id</dt>
|
||||
<dd><p>An ID string that corresponds with the ID used to call the module's
|
||||
UI function</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Additional parameters to pass to module server function</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>Session from which to make a child scope (the default should
|
||||
almost always be used)</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>The return value, if any, from executing the module server function</p>
|
||||
|
||||
|
||||
<p>The return value, if any, from executing the module server function</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -92,7 +101,7 @@ almost always be used)</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -73,21 +73,33 @@ selected values.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
||||
|
||||
|
||||
<dt>choices</dt>
|
||||
<dd><p>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 <code>choiceNames</code> and <code>choiceValues</code>
|
||||
must not be provided, and vice-versa. The values should be strings; other
|
||||
types (such as logicals and numbers) will be coerced to strings.</p></dd>
|
||||
|
||||
|
||||
<dt>selected</dt>
|
||||
<dd><p>The values that should be initially selected, if any.</p></dd>
|
||||
|
||||
|
||||
<dt>inline</dt>
|
||||
<dd><p>If <code>TRUE</code>, render the choices inline (i.e. horizontally)</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>choiceNames, choiceValues</dt>
|
||||
<dd><p>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 <em>must</em> be provided and <code>choices</code>
|
||||
a named list for <code>choices</code> is that <code>choiceNames</code> allows any
|
||||
type of UI object to be passed through (tag objects, icons, HTML code,
|
||||
...), instead of just simple text. See Examples.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A list of HTML elements that can be added to a UI definition.</p>
|
||||
|
||||
|
||||
<p>A list of HTML elements that can be added to a UI definition.</p>
|
||||
</div>
|
||||
<div id="server-value">
|
||||
<h2>Server value</h2>
|
||||
@@ -184,7 +199,7 @@ type of UI object to be passed through (tag objects, icons, HTML code,
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -60,17 +60,26 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
||||
|
||||
|
||||
<dt>value</dt>
|
||||
<dd><p>Initial value (<code>TRUE</code> or <code>FALSE</code>).</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A checkbox control that can be added to a UI definition.</p>
|
||||
|
||||
|
||||
<p>A checkbox control that can be added to a UI definition.</p>
|
||||
</div>
|
||||
<div id="server-value">
|
||||
<h2>Server value</h2>
|
||||
@@ -127,7 +136,7 @@ see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -73,25 +73,34 @@ hover events generated by imageOutput() and plotOutput()."><meta property="og:im
|
||||
<dl><dt>id</dt>
|
||||
<dd><p>Input value name. For example, if the value is <code>"plot_click"</code>,
|
||||
then the event data will be available as <code>input$plot_click</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>clip</dt>
|
||||
<dd><p>Should the click area be clipped to the plotting area? If
|
||||
<code>FALSE</code>, 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.</p></dd>
|
||||
|
||||
|
||||
<dt>delay</dt>
|
||||
<dd><p>For <code>dblClickOpts()</code>: the maximum delay (in ms) between a
|
||||
pair clicks for them to be counted as a double-click.</p>
|
||||
<p>For <code>hoverOpts()</code>: how long to delay (in ms) when debouncing or throttling
|
||||
before sending the mouse location to the server.</p></dd>
|
||||
|
||||
|
||||
<dt>delayType</dt>
|
||||
<dd><p>The type of algorithm for limiting the number of hover
|
||||
events. Use <code>"throttle"</code> to limit the number of hover events to one
|
||||
every <code>delay</code> milliseconds. Use <code>"debounce"</code> to suspend events
|
||||
while the cursor is moving, and wait until the cursor has been at rest for
|
||||
<code>delay</code> milliseconds before sending an event.</p></dd>
|
||||
|
||||
|
||||
<dt>nullOutside</dt>
|
||||
<dd><p>If <code>TRUE</code> (the default), the value will be set to
|
||||
<code>NULL</code> when the mouse exits the plotting area. If <code>FALSE</code>, the
|
||||
value will stop changing when the cursor exits the plotting area.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -110,7 +119,7 @@ value will stop changing when the cursor exits the plotting area.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -62,15 +62,22 @@ fixedRow()"><meta property="og:image" content="/logo.png"><!-- mathjax --><scrip
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>width</dt>
|
||||
<dd><p>The grid width of the column (must be between 1 and 12)</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Elements to include within the column</p></dd>
|
||||
|
||||
|
||||
<dt>offset</dt>
|
||||
<dd><p>The number of columns to offset this column from the end of the
|
||||
previous column.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A column that can be included within a
|
||||
|
||||
|
||||
<p>A column that can be included within a
|
||||
<code><a href="fluidPage.html">fluidRow()</a></code> or <code><a href="fixedPage.html">fixedRow()</a></code>.</p>
|
||||
</div>
|
||||
<div id="see-also">
|
||||
@@ -131,7 +138,7 @@ previous column.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -65,11 +65,16 @@ whenever Shiny detects a relevant change in input/output.</p>
|
||||
<dl><dt>condition</dt>
|
||||
<dd><p>A JavaScript expression that will be evaluated repeatedly to
|
||||
determine whether the panel should be displayed.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Elements to include in the panel.</p></dd>
|
||||
|
||||
|
||||
<dt>ns</dt>
|
||||
<dd><p>The <code><a href="NS.html">namespace()</a></code> object of the current module, if
|
||||
any.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -150,7 +155,7 @@ value.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -93,16 +93,22 @@ additional call(s).</p>
|
||||
<dd><p>A function without parameters, that returns user data. If the
|
||||
returned value is a promise, then the render function will proceed in async
|
||||
mode.</p></dd>
|
||||
|
||||
|
||||
<dt>transform</dt>
|
||||
<dd><p>A function that takes four arguments: <code>value</code>,
|
||||
<code>session</code>, <code>name</code>, and <code>...</code> (for future-proofing). This
|
||||
function will be invoked each time a value is returned from <code>func</code>,
|
||||
and is responsible for changing the value into a JSON-ready value to be
|
||||
JSON-encoded and sent to the browser.</p></dd>
|
||||
|
||||
|
||||
<dt>outputFunc</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>outputArgs</dt>
|
||||
<dd><p>A list of arguments to pass to the <code>uiFunc</code>. Render
|
||||
functions should include <code>outputArgs = list()</code> in their own parameter list,
|
||||
@@ -110,18 +116,24 @@ and pass through the value to <code>markRenderFunction</code>, 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).</p></dd>
|
||||
|
||||
|
||||
<dt>cacheHint</dt>
|
||||
<dd><p>One of <code>"auto"</code>, <code>FALSE</code>, or some other information to
|
||||
identify this instance for caching using <code><a href="bindCache.html">bindCache()</a></code>. If <code>"auto"</code>, it
|
||||
will try to automatically infer caching information. If <code>FALSE</code>, do not
|
||||
allow caching for the object. Some render functions (such as <a href="renderPlot.html">renderPlot</a>)
|
||||
contain internal state that makes them unsuitable for caching.</p></dd>
|
||||
|
||||
|
||||
<dt>cacheWriteHook</dt>
|
||||
<dd><p>Used if the render function is passed to <code><a href="bindCache.html">bindCache()</a></code>.
|
||||
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 <code>renderFunc</code>, and should return the value
|
||||
to store in the cache.</p></dd>
|
||||
|
||||
|
||||
<dt>cacheReadHook</dt>
|
||||
<dd><p>Used if the render function is passed to <code><a href="bindCache.html">bindCache()</a></code>.
|
||||
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 <code><a href="createWebDependency.html">createWebDependency()</a></code> so that Shiny
|
||||
is able to serve JS and CSS resources.</p></dd>
|
||||
|
||||
|
||||
<dt>q</dt>
|
||||
<dd><p>Quosure of the expression <code>x</code>. When capturing expressions to create
|
||||
your quosure, it is recommended to use <code>enquo0()</code> to not unquote the
|
||||
object too early. See <code>enquo0()</code> for more details.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>A label for the object to be shown in the debugger. Defaults to
|
||||
the name of the calling function.</p></dd>
|
||||
|
||||
|
||||
<dt>expr</dt>
|
||||
<dd><p>A quoted or unquoted expression, or a quosure.</p></dd>
|
||||
|
||||
|
||||
<dt>name</dt>
|
||||
<dd><p>The name the function should be given</p></dd>
|
||||
|
||||
|
||||
<dt>eval.env</dt>
|
||||
<dd><p>The desired environment for the function. Defaults to the
|
||||
calling environment two steps back.</p></dd>
|
||||
|
||||
|
||||
<dt>quoted</dt>
|
||||
<dd><p>Is the expression quoted?</p></dd>
|
||||
|
||||
|
||||
<dt>assign.env</dt>
|
||||
<dd><p>The environment in which the function should be assigned.</p></dd>
|
||||
|
||||
|
||||
<dt>wrappedWithLabel, ..stacktraceon</dt>
|
||||
<dd><p>Advanced use only. For stack manipulation purposes; see
|
||||
<code><a href="stacktrace.html">stacktrace()</a></code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>An annotated render function, ready to be assigned to an
|
||||
|
||||
|
||||
<p>An annotated render function, ready to be assigned to an
|
||||
<code>output</code> slot.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
@@ -258,7 +289,7 @@ function that's assigned to a <code>name</code> in the <code>assign.env</code>.<
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -68,16 +68,21 @@ URL.</p>
|
||||
<dd><p>A single HTML dependency object, created using
|
||||
<code><a href="https://rdrr.io/pkg/htmltools/man/htmlDependency.html" class="external-link">htmltools::htmlDependency()</a></code>. If the <code>src</code> value is named,
|
||||
then <code>href</code> and/or <code>file</code> names must be present.</p></dd>
|
||||
|
||||
|
||||
<dt>scrubFile</dt>
|
||||
<dd><p>If TRUE (the default), remove <code>src$file</code> 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
|
||||
<code>src$file</code>. Setting it to FALSE should be needed only in very unusual
|
||||
cases.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A single HTML dependency object that has an <code>href</code>-named element
|
||||
|
||||
|
||||
<p>A single HTML dependency object that has an <code>href</code>-named element
|
||||
in its <code>src</code>.</p>
|
||||
</div>
|
||||
|
||||
@@ -93,7 +98,7 @@ in its <code>src</code>.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -76,27 +76,43 @@ the user can click on to select dates.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
||||
|
||||
|
||||
<dt>value</dt>
|
||||
<dd><p>The starting date. Either a Date object, or a string in
|
||||
<code>yyyy-mm-dd</code> format. If NULL (the default), will use the current date
|
||||
in the client's time zone.</p></dd>
|
||||
|
||||
|
||||
<dt>min</dt>
|
||||
<dd><p>The minimum allowed date. Either a Date object, or a string in
|
||||
<code>yyyy-mm-dd</code> format.</p></dd>
|
||||
|
||||
|
||||
<dt>max</dt>
|
||||
<dd><p>The maximum allowed date. Either a Date object, or a string in
|
||||
<code>yyyy-mm-dd</code> format.</p></dd>
|
||||
|
||||
|
||||
<dt>format</dt>
|
||||
<dd><p>The format of the date to display in the browser. Defaults to
|
||||
<code>"yyyy-mm-dd"</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>startview</dt>
|
||||
<dd><p>The date range shown when the input object is first clicked.
|
||||
Can be "month" (the default), "year", or "decade".</p></dd>
|
||||
|
||||
|
||||
<dt>weekstart</dt>
|
||||
<dd><p>Which day is the start of the week. Should be an integer
|
||||
from 0 (Sunday) to 6 (Saturday).</p></dd>
|
||||
|
||||
|
||||
<dt>language</dt>
|
||||
<dd><p>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".</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>autoclose</dt>
|
||||
<dd><p>Whether or not to close the datepicker immediately when a
|
||||
date is selected.</p></dd>
|
||||
|
||||
|
||||
<dt>datesdisabled</dt>
|
||||
<dd><p>Which dates should be disabled. Either a Date object,
|
||||
or a string in <code>yyyy-mm-dd</code> format.</p></dd>
|
||||
|
||||
|
||||
<dt>daysofweekdisabled</dt>
|
||||
<dd><p>Days of the week that should be disabled. Should be
|
||||
a integer vector with values from 0 (Sunday) to 6 (Saturday).</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -211,7 +236,7 @@ the browser. It allows the following values:</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -76,31 +76,49 @@ the user can click on to select dates.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
||||
|
||||
|
||||
<dt>start</dt>
|
||||
<dd><p>The initial start date. Either a Date object, or a string in
|
||||
<code>yyyy-mm-dd</code> format. If NULL (the default), will use the current
|
||||
date in the client's time zone.</p></dd>
|
||||
|
||||
|
||||
<dt>end</dt>
|
||||
<dd><p>The initial end date. Either a Date object, or a string in
|
||||
<code>yyyy-mm-dd</code> format. If NULL (the default), will use the current
|
||||
date in the client's time zone.</p></dd>
|
||||
|
||||
|
||||
<dt>min</dt>
|
||||
<dd><p>The minimum allowed date. Either a Date object, or a string in
|
||||
<code>yyyy-mm-dd</code> format.</p></dd>
|
||||
|
||||
|
||||
<dt>max</dt>
|
||||
<dd><p>The maximum allowed date. Either a Date object, or a string in
|
||||
<code>yyyy-mm-dd</code> format.</p></dd>
|
||||
|
||||
|
||||
<dt>format</dt>
|
||||
<dd><p>The format of the date to display in the browser. Defaults to
|
||||
<code>"yyyy-mm-dd"</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>startview</dt>
|
||||
<dd><p>The date range shown when the input object is first clicked.
|
||||
Can be "month" (the default), "year", or "decade".</p></dd>
|
||||
|
||||
|
||||
<dt>weekstart</dt>
|
||||
<dd><p>Which day is the start of the week. Should be an integer
|
||||
from 0 (Sunday) to 6 (Saturday).</p></dd>
|
||||
|
||||
|
||||
<dt>language</dt>
|
||||
<dd><p>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".</p></dd>
|
||||
|
||||
|
||||
<dt>separator</dt>
|
||||
<dd><p>String to display between the start and end input boxes.</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>autoclose</dt>
|
||||
<dd><p>Whether or not to close the datepicker immediately when a
|
||||
date is selected.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -215,7 +240,7 @@ the browser. It allows the following values:</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -74,17 +74,24 @@ invalidation signals; see Details.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>r</dt>
|
||||
<dd><p>A reactive expression (that invalidates too often).</p></dd>
|
||||
|
||||
|
||||
<dt>millis</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>priority</dt>
|
||||
<dd><p>Debounce/throttle is implemented under the hood using
|
||||
<a href="observe.html">observers</a>. 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).</p></dd>
|
||||
|
||||
|
||||
<dt>domain</dt>
|
||||
<dd><p>See <a href="domains.html">domains</a>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -185,7 +192,7 @@ has expired.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -97,37 +97,60 @@ by calling <code>devmode(FALSE)</code>.</p>
|
||||
<dl><dt>devmode</dt>
|
||||
<dd><p>Logical value which should be set to <code>TRUE</code> to enable Shiny
|
||||
Developer Mode</p></dd>
|
||||
|
||||
|
||||
<dt>verbose</dt>
|
||||
<dd><p>Logical value which should be set to <code>TRUE</code> display Shiny
|
||||
Developer messages</p></dd>
|
||||
|
||||
|
||||
<dt>code</dt>
|
||||
<dd><p>Code to execute with the temporary Dev Mode options set</p></dd>
|
||||
|
||||
|
||||
<dt>message</dt>
|
||||
<dd><p>Developer Mode message to be sent to <code><a href="https://rlang.r-lib.org/reference/abort.html" class="external-link">rlang::inform()</a></code></p></dd>
|
||||
|
||||
|
||||
<dt>.frequency</dt>
|
||||
<dd><p>Frequency of the Developer Mode message used with
|
||||
<code><a href="https://rlang.r-lib.org/reference/abort.html" class="external-link">rlang::inform()</a></code>. Defaults to once every 8 hours.</p></dd>
|
||||
|
||||
|
||||
<dt>.frequency_id</dt>
|
||||
<dd><p><code><a href="https://rlang.r-lib.org/reference/abort.html" class="external-link">rlang::inform()</a></code> message identifier. Defaults to
|
||||
<code>message</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>.file</dt>
|
||||
<dd><p>Output connection for <code><a href="https://rlang.r-lib.org/reference/abort.html" class="external-link">rlang::inform()</a></code>. Defaults to <code><a href="https://rdrr.io/r/base/showConnections.html" class="external-link">stderr()</a></code></p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Parameters passed to <code><a href="https://rlang.r-lib.org/reference/abort.html" class="external-link">rlang::inform()</a></code></p></dd>
|
||||
|
||||
|
||||
<dt>name</dt>
|
||||
<dd><p>Name of option to look for in <code><a href="https://rdrr.io/r/base/options.html" class="external-link">options()</a></code></p></dd>
|
||||
|
||||
|
||||
<dt>devmode_message</dt>
|
||||
<dd><p>Message to display once every 8 hours when utilizing
|
||||
the <code>devmode_default</code> value. If <code>devmode_message</code> is missing, the
|
||||
registered <code>devmode_message</code> value be used.</p></dd>
|
||||
|
||||
|
||||
<dt>devmode_default</dt>
|
||||
<dd><p>Default value to return if <code>in_devmode()</code> returns
|
||||
<code>TRUE</code> and the specified option is not set in <code><a href="https://rdrr.io/r/base/options.html" class="external-link">options()</a></code>. For
|
||||
<code>get_devmode_option()</code>, if <code>devmode_default</code> is missing, the
|
||||
registered <code>devmode_default</code> value will be used.</p></dd>
|
||||
|
||||
|
||||
<dt>default</dt>
|
||||
<dd><p>Default value to return if <code>in_devmode()</code> returns
|
||||
<code>TRUE</code> and the specified option is not set in <code><a href="https://rdrr.io/r/base/options.html" class="external-link">options()</a></code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="functions">
|
||||
<h2>Functions</h2>
|
||||
@@ -300,7 +323,7 @@ not recommended for all reimplementation situations.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -71,36 +71,53 @@
|
||||
<dl><dt>dir</dt>
|
||||
<dd><p>Directory to store files for the cache. If <code>NULL</code> (the default) it
|
||||
will create and use a temporary directory.</p></dd>
|
||||
|
||||
|
||||
<dt>max_size</dt>
|
||||
<dd><p>Maximum size of the cache, in bytes. If the cache exceeds
|
||||
this size, cached objects will be removed according to the value of the
|
||||
<code>evict</code>. Use <code>Inf</code> for no size limit. The default is 1 gigabyte.</p></dd>
|
||||
|
||||
|
||||
<dt>max_age</dt>
|
||||
<dd><p>Maximum age of files in cache before they are evicted, in
|
||||
seconds. Use <code>Inf</code> for no age limit.</p></dd>
|
||||
|
||||
|
||||
<dt>max_n</dt>
|
||||
<dd><p>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 <code>evict</code>. Use <code>Inf</code> for no limit of number of items.</p></dd>
|
||||
|
||||
|
||||
<dt>evict</dt>
|
||||
<dd><p>The eviction policy to use to decide which objects are removed
|
||||
when a cache pruning occurs. Currently, <code>"lru"</code> and <code>"fifo"</code> are supported.</p></dd>
|
||||
|
||||
|
||||
<dt>destroy_on_finalize</dt>
|
||||
<dd><p>If <code>TRUE</code>, then when the cache_disk object is
|
||||
garbage collected, the cache directory and all objects inside of it will be
|
||||
deleted from disk. If <code>FALSE</code> (the default), it will do nothing when
|
||||
finalized.</p></dd>
|
||||
|
||||
|
||||
<dt>missing</dt>
|
||||
<dd><p>A value to return when <code>get(key)</code> is called but the key is not
|
||||
present in the cache. The default is a <code><a href="https://r-lib.github.io/fastmap/reference/key_missing.html" class="external-link">key_missing()</a></code> object. It is
|
||||
actually an expression that is evaluated each time there is a cache miss.
|
||||
See section Missing keys for more information.</p></dd>
|
||||
|
||||
|
||||
<dt>exec_missing</dt>
|
||||
<dd><p>Deprecated.</p></dd>
|
||||
|
||||
|
||||
<dt>logfile</dt>
|
||||
<dd><p>An optional filename or connection object to where logging
|
||||
information will be written. To log to the console, use <code><a href="https://rdrr.io/r/base/showConnections.html" class="external-link">stderr()</a></code> or
|
||||
<code><a href="https://rdrr.io/r/base/showConnections.html" class="external-link">stdout()</a></code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@@ -115,7 +132,7 @@ information will be written. To log to the console, use <code><a href="https://r
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -73,13 +73,20 @@ them ends) and error handling.</p>
|
||||
<dl><dt>domain</dt>
|
||||
<dd><p>A valid domain object (for example, a Shiny session), or
|
||||
<code>NULL</code></p></dd>
|
||||
|
||||
|
||||
<dt>expr</dt>
|
||||
<dd><p>An expression to evaluate under <code>domain</code></p></dd>
|
||||
|
||||
|
||||
<dt>callback</dt>
|
||||
<dd><p>A callback function to be invoked</p></dd>
|
||||
|
||||
|
||||
<dt>failIfNull</dt>
|
||||
<dd><p>If <code>TRUE</code> then an error is given if the <code>domain</code>
|
||||
is <code>NULL</code></p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -112,7 +119,7 @@ never be invoked.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -75,14 +75,23 @@ function.</p>
|
||||
<dl><dt>outputId</dt>
|
||||
<dd><p>The name of the output slot that the <code>downloadHandler</code>
|
||||
is assigned to.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>The label that should appear on the button.</p></dd>
|
||||
|
||||
|
||||
<dt>class</dt>
|
||||
<dd><p>Additional CSS classes to apply to the tag, if any.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Other arguments to pass to the container tag function.</p></dd>
|
||||
|
||||
|
||||
<dt>icon</dt>
|
||||
<dd><p>An <code><a href="icon.html">icon()</a></code> to appear on the button. Default is <code>icon("download")</code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -127,7 +136,7 @@ is assigned to.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -75,21 +75,28 @@ download available.</p>
|
||||
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.)</p></dd>
|
||||
|
||||
|
||||
<dt>content</dt>
|
||||
<dd><p>A function that takes a single argument <code>file</code> 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.)</p></dd>
|
||||
|
||||
|
||||
<dt>contentType</dt>
|
||||
<dd><p>A string of the download's
|
||||
<a href="https://en.wikipedia.org/wiki/Internet_media_type" class="external-link">content type</a>, for
|
||||
example <code>"text/csv"</code> or <code>"image/png"</code>. If <code>NULL</code>, the content type
|
||||
will be guessed based on the filename extension, or
|
||||
<code>application/octet-stream</code> if the extension is unknown.</p></dd>
|
||||
|
||||
|
||||
<dt>outputArgs</dt>
|
||||
<dd><p>A list of arguments to be passed through to the implicit
|
||||
call to <code><a href="downloadButton.html">downloadButton()</a></code> when <code>downloadHandler</code> is used
|
||||
in an interactive R Markdown document.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
<div id="ref-examples">
|
||||
@@ -131,7 +138,7 @@ in an interactive R Markdown document.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -82,6 +82,7 @@ when the bookmarked state requires storing files.</p>
|
||||
<dd><p>Either <code>"url"</code>, which encodes all of the relevant values in
|
||||
a URL, <code>"server"</code>, which saves to disk on the server, or
|
||||
<code>"disable"</code>, which disables any previously-enabled bookmarking.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -294,7 +295,7 @@ restored.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -68,12 +68,19 @@ event occurs. These events are triggered by accessing a snapshot URL.</p>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>Named arguments that are quoted or unquoted expressions that will
|
||||
be captured and evaluated when snapshot URL is visited.</p></dd>
|
||||
|
||||
|
||||
<dt>quoted_</dt>
|
||||
<dd><p>Are the expression quoted? Default is <code>FALSE</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>env_</dt>
|
||||
<dd><p>The environment in which the expression should be evaluated.</p></dd>
|
||||
|
||||
|
||||
<dt>session_</dt>
|
||||
<dd><p>A Shiny session object.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -138,7 +145,7 @@ global option <code>shiny.testmode</code> to <code>TRUE</code>.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -64,11 +64,16 @@ debugging experience (Shiny 0.8.0). If the <code>expr</code> and <code>quoted</c
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>expr</dt>
|
||||
<dd><p>A quoted or unquoted expression, or a quosure.</p></dd>
|
||||
|
||||
|
||||
<dt>env</dt>
|
||||
<dd><p>The desired environment for the function. Defaults to the
|
||||
calling environment two steps back.</p></dd>
|
||||
|
||||
|
||||
<dt>quoted</dt>
|
||||
<dd><p>Is the expression quoted?</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -91,7 +96,7 @@ calling environment two steps back.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -69,12 +69,18 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
||||
|
||||
|
||||
<dt>multiple</dt>
|
||||
<dd><p>Whether the user should be allowed to select and upload
|
||||
multiple files at once. <strong>Does not work on older browsers, including
|
||||
Internet Explorer 9 and earlier.</strong></p></dd>
|
||||
|
||||
|
||||
<dt>accept</dt>
|
||||
<dd><p>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.</p>
|
||||
<li><p>One of <code>audio/*</code>, <code>video/*</code>, or <code>image/*</code> meaning any audio, video,
|
||||
or image type, respectively.</p></li>
|
||||
</ul></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>buttonLabel</dt>
|
||||
<dd><p>The label used on the button. Can be text or an HTML tag
|
||||
object.</p></dd>
|
||||
|
||||
|
||||
<dt>placeholder</dt>
|
||||
<dd><p>The text to show before a file has been uploaded.</p></dd>
|
||||
|
||||
|
||||
<dt>capture</dt>
|
||||
<dd><p>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.</p>
|
||||
<p>By default on most phones, this will accept still photos or video. For
|
||||
still photos only, also use <code>accept="image/*"</code>. For video only, use
|
||||
<code>accept="video/*"</code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -199,7 +214,7 @@ operation.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -69,6 +69,8 @@ available area of the browser window.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>Elements to include within the page.</p></dd>
|
||||
|
||||
|
||||
<dt>padding</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>title</dt>
|
||||
<dd><p>The title to use for the browser window/tab (it will not be
|
||||
shown in the document).</p></dd>
|
||||
|
||||
|
||||
<dt>bootstrap</dt>
|
||||
<dd><p>If <code>TRUE</code>, load the Bootstrap CSS library.</p></dd>
|
||||
|
||||
|
||||
<dt>theme</dt>
|
||||
<dd><p>One of the following:</p><ul><li><p><code>NULL</code> (the default), which implies a "stock" build of Bootstrap 3.</p></li>
|
||||
<li><p>A <code><a href="https://rstudio.github.io/bslib/reference/bs_theme.html" class="external-link">bslib::bs_theme()</a></code> 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.</p></li
|
||||
<li><p>A character string pointing to an alternative Bootstrap stylesheet
|
||||
(normally a css file within the www directory, e.g. <code>www/bootstrap.css</code>).</p></li>
|
||||
</ul></dd>
|
||||
|
||||
|
||||
<dt>lang</dt>
|
||||
<dd><p>ISO 639-1 language code for the HTML page, such as "en" or "ko".
|
||||
This will be used as the lang in the <code><html></code> tag, as in <code><html lang="en"></code>.
|
||||
The default (NULL) results in an empty string.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -189,7 +200,7 @@ package.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -74,6 +74,8 @@ occupy a single cell. (To put multiple items in a single cell, you can use
|
||||
<code><a href="https://rdrr.io/pkg/htmltools/man/tagList.html" class="external-link">tagList()</a></code> or <code><a href="https://rdrr.io/pkg/htmltools/man/builder.html" class="external-link">div()</a></code> to combine them.) Named
|
||||
arguments will be used as attributes on the <code>div</code> element that
|
||||
encapsulates the row/column.</p></dd>
|
||||
|
||||
|
||||
<dt>flex</dt>
|
||||
<dd><p>Determines how space should be distributed to the cells. Can be a
|
||||
single value like <code>1</code> or <code>2</code> to evenly distribute the available
|
||||
@@ -81,12 +83,15 @@ space; or use a vector of numbers to specify the proportions. For example,
|
||||
<code>flex = c(2, 3)</code> 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).</p></dd>
|
||||
|
||||
|
||||
<dt>width, height</dt>
|
||||
<dd><p>The total amount of width and height to use for the
|
||||
entire row/column. For the default height of <code>"100%"</code> to be
|
||||
effective, the parent must be <code>fillPage</code>, another
|
||||
<code>fillRow</code>/<code>fillCol</code>, or some other HTML element whose height is
|
||||
not determined by the height of its contents.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -139,7 +144,7 @@ the size of their contents, as is usually the case in HTML).</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -74,8 +74,12 @@ displays respectively.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>Elements to include within the container</p></dd>
|
||||
|
||||
|
||||
<dt>title</dt>
|
||||
<dd><p>The browser window title (defaults to the host URL of the page)</p></dd>
|
||||
|
||||
|
||||
<dt>theme</dt>
|
||||
<dd><p>One of the following:</p><ul><li><p><code>NULL</code> (the default), which implies a "stock" build of Bootstrap 3.</p></li>
|
||||
<li><p>A <code><a href="https://rstudio.github.io/bslib/reference/bs_theme.html" class="external-link">bslib::bs_theme()</a></code> 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.</p></li
|
||||
<li><p>A character string pointing to an alternative Bootstrap stylesheet
|
||||
(normally a css file within the www directory, e.g. <code>www/bootstrap.css</code>).</p></li>
|
||||
</ul></dd>
|
||||
|
||||
|
||||
<dt>lang</dt>
|
||||
<dd><p>ISO 639-1 language code for the HTML page, such as "en" or "ko".
|
||||
This will be used as the lang in the <code><html></code> tag, as in <code><html lang="en"></code>.
|
||||
The default (NULL) results in an empty string.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function.</p>
|
||||
|
||||
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -152,7 +161,7 @@ pages.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -67,9 +67,12 @@ well with elements that have a percentage-based width (e.g.
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>Unnamed arguments will become child elements of the layout. Named
|
||||
arguments will become HTML attributes on the outermost tag.</p></dd>
|
||||
|
||||
|
||||
<dt>cellArgs</dt>
|
||||
<dd><p>Any additional attributes that should be used for each cell
|
||||
of the layout.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -109,7 +112,7 @@ of the layout.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -72,9 +72,13 @@ components in realtime to fill all available browser width.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>Elements to include within the page</p></dd>
|
||||
|
||||
|
||||
<dt>title</dt>
|
||||
<dd><p>The browser window title (defaults to the host URL of the page).
|
||||
Can also be set as a side effect of the <code><a href="titlePanel.html">titlePanel()</a></code> function.</p></dd>
|
||||
|
||||
|
||||
<dt>theme</dt>
|
||||
<dd><p>One of the following:</p><ul><li><p><code>NULL</code> (the default), which implies a "stock" build of Bootstrap 3.</p></li>
|
||||
<li><p>A <code><a href="https://rstudio.github.io/bslib/reference/bs_theme.html" class="external-link">bslib::bs_theme()</a></code> 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.</p></li
|
||||
<li><p>A character string pointing to an alternative Bootstrap stylesheet
|
||||
(normally a css file within the www directory, e.g. <code>www/bootstrap.css</code>).</p></li>
|
||||
</ul></dd>
|
||||
|
||||
|
||||
<dt>lang</dt>
|
||||
<dd><p>ISO 639-1 language code for the HTML page, such as "en" or "ko".
|
||||
This will be used as the lang in the <code><html></code> tag, as in <code><html lang="en"></code>.
|
||||
The default (NULL) results in an empty string.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function.</p>
|
||||
|
||||
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -185,7 +194,7 @@ pages.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -82,8 +82,11 @@ If this affects your app, please let us know by leaving a comment on
|
||||
<dd><p>For <code>freezeReactiveValue</code>, a <code><a href="reactiveValues.html">reactiveValues()</a></code>
|
||||
object (like <code>input</code>); for <code>freezeReactiveVal</code>, a
|
||||
<code><a href="reactiveVal.html">reactiveVal()</a></code> object.</p></dd>
|
||||
|
||||
|
||||
<dt>name</dt>
|
||||
<dd><p>The name of a value in the <code><a href="reactiveValues.html">reactiveValues()</a></code> object.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -140,7 +143,7 @@ object (like <code>input</code>); for <code>freezeReactiveVal</code>, a
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -62,10 +62,13 @@ and in some cases, relevant sizing and styling information.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>session</dt>
|
||||
<dd><p>The current Shiny session.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p><code>NULL</code> if called outside of an output context; otherwise,
|
||||
|
||||
|
||||
<p><code>NULL</code> if called outside of an output context; otherwise,
|
||||
a list which includes:</p><ul><li><p>The <code>name</code> of the output (reported for any output).</p></li>
|
||||
<li><p>If the output is a <code><a href="plotOutput.html">plotOutput()</a></code> or <code><a href="plotOutput.html">imageOutput()</a></code>, then:</p><ul><li><p><code>height</code>: a reactive expression which returns the height in pixels.</p></li>
|
||||
<li><p><code>width</code>: a reactive expression which returns the width in pixels.</p></li>
|
||||
@@ -133,7 +136,7 @@ a list which includes:</p><ul><li><p>The <code>name</code> of the output (report
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -60,8 +60,13 @@ styling based on the <code><a href="bootstrapLib.html">bootstrapLib()</a></code>
|
||||
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>If called at render-time (i.e., inside a <code><a href="https://rdrr.io/pkg/htmltools/man/tagFunction.html" class="external-link">htmltools::tagFunction()</a></code>),
|
||||
and <code><a href="bootstrapLib.html">bootstrapLib()</a></code>'s <code>theme</code> has been set to a <code><a href="https://rstudio.github.io/bslib/reference/bs_theme.html" class="external-link">bslib::bs_theme()</a></code>object, then this returns the <code>theme</code>. Otherwise, this returns <code>NULL</code>.</p>
|
||||
|
||||
|
||||
<p>If called at render-time (i.e., inside a <code><a href="https://rdrr.io/pkg/htmltools/man/tagFunction.html" class="external-link">htmltools::tagFunction()</a></code>),
|
||||
and <code><a href="bootstrapLib.html">bootstrapLib()</a></code>'s <code>theme</code> has been set to a <code><a href="https://rstudio.github.io/bslib/reference/bs_theme.html" class="external-link">bslib::bs_theme()</a></code></p>
|
||||
|
||||
|
||||
<p>object, then this returns the <code>theme</code>. Otherwise, this returns <code>NULL</code>.</p>
|
||||
</div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -80,7 +85,7 @@ and <code><a href="bootstrapLib.html">bootstrapLib()</a></code>'s <code>theme</c
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -64,10 +64,13 @@ component from the app's URL.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>session</dt>
|
||||
<dd><p>A Shiny session object.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>For <code>getQueryString</code>, a named list. For example, the query
|
||||
|
||||
|
||||
<p>For <code>getQueryString</code>, a named list. For example, the query
|
||||
string <code>?param1=value1&param2=value2</code> becomes <code>list(param1 = value1, param2 = value2)</code>. For <code>getUrlHash</code>, a character vector with
|
||||
the hash (including the leading <code>#</code> symbol).</p>
|
||||
</div>
|
||||
@@ -157,7 +160,7 @@ to worry about this.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -60,13 +60,20 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>title</dt>
|
||||
<dd><p>An application title to display</p></dd>
|
||||
|
||||
|
||||
<dt>windowTitle</dt>
|
||||
<dd><p>The title that should be displayed by the browser window.
|
||||
Useful if <code>title</code> is not a string.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A headerPanel that can be passed to <a href="pageWithSidebar.html">pageWithSidebar</a></p>
|
||||
|
||||
|
||||
<p>A headerPanel that can be passed to <a href="pageWithSidebar.html">pageWithSidebar</a></p>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -81,7 +88,7 @@ Useful if <code>title</code> is not a string.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -62,10 +62,13 @@ explanation or context.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>One or more help text strings (or other inline HTML elements)</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A help text element that can be added to a UI definition.</p>
|
||||
|
||||
|
||||
<p>A help text element that can be added to a UI definition.</p>
|
||||
</div>
|
||||
|
||||
<div id="ref-examples">
|
||||
@@ -92,7 +95,7 @@ explanation or context.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -71,18 +71,27 @@ contain HTML content which should not be escaped.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>outputId</dt>
|
||||
<dd><p>output variable to read the value from</p></dd>
|
||||
|
||||
|
||||
<dt>inline</dt>
|
||||
<dd><p>use an inline (<code><a href="https://rdrr.io/pkg/htmltools/man/builder.html" class="external-link">span()</a></code>) or block container (<code><a href="https://rdrr.io/pkg/htmltools/man/builder.html" class="external-link">div()</a></code>)
|
||||
for the output</p></dd>
|
||||
|
||||
|
||||
<dt>container</dt>
|
||||
<dd><p>a function to generate an HTML element to contain the text</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Other arguments to pass to the container tag function. This is
|
||||
useful for providing additional classes for the tag.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>An HTML output element that can be included in a panel</p>
|
||||
|
||||
|
||||
<p>An HTML output element that can be included in a panel</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -116,7 +125,7 @@ side. It is currently just an alias for <code>htmlOutput</code>.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -65,15 +65,22 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>status</dt>
|
||||
<dd><p>HTTP status code for the response.</p></dd>
|
||||
|
||||
|
||||
<dt>content_type</dt>
|
||||
<dd><p>The value for the <code>Content-Type</code> header.</p></dd>
|
||||
|
||||
|
||||
<dt>content</dt>
|
||||
<dd><p>The body of the response, given as a single-element character
|
||||
vector (will be encoded as UTF-8) or a raw vector.</p></dd>
|
||||
|
||||
|
||||
<dt>headers</dt>
|
||||
<dd><p>A named list of additional headers to include. Do not include
|
||||
<code>Content-Length</code> (as it is automatically calculated) or <code>Content-Type</code> (the
|
||||
<code>content_type</code> argument is used instead).</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
<div id="ref-examples">
|
||||
@@ -113,7 +120,7 @@ vector (will be encoded as UTF-8) or a raw vector.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -68,18 +68,27 @@ of a button, and/or used with <code><a href="tabPanel.html">tabPanel()</a></code
|
||||
<code>"fa-calendar"</code> icon should be referred to as <code>"calendar"</code>). A <code>name</code> of
|
||||
<code>NULL</code> may also be provided to get a raw <code><i></code> tag with no library attached
|
||||
to it.</p></dd>
|
||||
|
||||
|
||||
<dt>class</dt>
|
||||
<dd><p>Additional classes to customize the style of an icon (see the
|
||||
<a href="https://fontawesome.com/how-to-use" class="external-link">usage examples</a> for details on
|
||||
supported styles).</p></dd>
|
||||
|
||||
|
||||
<dt>lib</dt>
|
||||
<dd><p>The icon library to use. Either <code>"font-awesome"</code> or <code>"glyphicon"</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Arguments passed to the <code><i></code> tag of <a href="https://rdrr.io/pkg/htmltools/man/builder.html" class="external-link">htmltools::tags</a>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>An <code><i></code> (icon) HTML tag.</p>
|
||||
|
||||
|
||||
<p>An <code><i></code> (icon) HTML tag.</p>
|
||||
</div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -111,21 +120,21 @@ and <a href="https://getbootstrap.com/docs/3.3/components/#glyphicons" class="ex
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="navbar-header"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <span class="navbar-brand">App Title</span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav navbar-nav" data-tabsetid="7753"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav navbar-nav" data-tabsetid="4848"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li class="active"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-7753-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-4848-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <i aria-label="bar-chart-o icon" class="fa fa-bar-chart-o fa-fw" role="presentation"></i></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> Plot</span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-7753-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-4848-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <i aria-label="list-alt icon" class="fa fa-list-alt fa-fw" role="presentation"></i></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> Summary</span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-7753-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-4848-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <i aria-label="table icon" class="fa fa-table fa-fw" role="presentation"></i></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> Table</span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </a></span>
|
||||
@@ -134,10 +143,10 @@ and <a href="https://getbootstrap.com/docs/3.3/components/#glyphicons" class="ex
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </nav></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="container-fluid"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="7753"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-icon-class="fa fa-bar-chart-o fa-fw" data-value="Plot" id="tab-7753-1"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Summary" data-icon-class="fa fa-list-alt fa-fw" id="tab-7753-2"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Table" data-icon-class="fa fa-table fa-fw" id="tab-7753-3"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="4848"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-icon-class="fa fa-bar-chart-o fa-fw" data-value="Plot" id="tab-4848-1"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Summary" data-icon-class="fa fa-list-alt fa-fw" id="tab-4848-2"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Table" data-icon-class="fa fa-table fa-fw" id="tab-4848-3"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
</code></pre></div>
|
||||
@@ -154,7 +163,7 @@ and <a href="https://getbootstrap.com/docs/3.3/components/#glyphicons" class="ex
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -647,7 +647,7 @@
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -62,6 +62,7 @@ suitable for wrapping inputs.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>Input controls or other HTML elements.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@@ -76,7 +77,7 @@ suitable for wrapping inputs.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -91,22 +91,34 @@ navlistPanel() or navbarPage()."><meta property="og:image" content="/logo.png"><
|
||||
<dd><p>The <code>id</code> of the <code>tabsetPanel</code> (or
|
||||
<code>navlistPanel</code> or <code>navbarPage</code>) into which <code>tab</code> will
|
||||
be inserted/removed.</p></dd>
|
||||
|
||||
|
||||
<dt>tab</dt>
|
||||
<dd><p>The item to be added (must be created with <code>tabPanel</code>,
|
||||
or with <code>navbarMenu</code>).</p></dd>
|
||||
|
||||
|
||||
<dt>target</dt>
|
||||
<dd><p>If inserting: the <code>value</code> of an existing
|
||||
<code>tabPanel</code>, next to which <code>tab</code> will be added.
|
||||
If removing: the <code>value</code> of the <code>tabPanel</code> that
|
||||
you want to remove. See Details if you want to insert next to/remove
|
||||
an entire <code>navbarMenu</code> instead.</p></dd>
|
||||
|
||||
|
||||
<dt>position</dt>
|
||||
<dd><p>Should <code>tab</code> be added before or after the
|
||||
<code>target</code> tab?</p></dd>
|
||||
|
||||
|
||||
<dt>select</dt>
|
||||
<dd><p>Should <code>tab</code> be selected upon being inserted?</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>The shiny session within which to call this function.</p></dd>
|
||||
|
||||
|
||||
<dt>menuName</dt>
|
||||
<dd><p>This argument should only be used when you want to
|
||||
prepend (or append) <code>tab</code> to the beginning (or end) of an
|
||||
@@ -119,6 +131,7 @@ of the <code>title</code> argument). Note that you still need to set the
|
||||
<code>navbarPage</code> is. If <code>menuName</code> is left as <code>NULL</code>,
|
||||
<code>tab</code> will be prepended (or appended) to whatever
|
||||
<code>inputId</code> is.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -226,7 +239,7 @@ this is equal to the value of the <code>title</code> argument).</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -98,6 +98,8 @@ note that many of these are wrapped in <code><div></code>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 <code><div></code> with an id.)</p></dd>
|
||||
|
||||
|
||||
<dt>where</dt>
|
||||
<dd><p>Where your UI object should go relative to the selector:</p><dl><dt><code>beforeBegin</code></dt>
|
||||
<dd><p>Before the selector element itself</p></dd>
|
||||
@@ -115,6 +117,8 @@ last child (default)</p></dd>
|
||||
|
||||
|
||||
</dl><p>Adapted from <a href="https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentHTML" class="external-link">https://developer.mozilla.org/en-US/docs/Web/API/Element/insertAdjacentHTML</a>.</p></dd>
|
||||
|
||||
|
||||
<dt>ui</dt>
|
||||
<dd><p>The UI object you want to insert. This can be anything that
|
||||
you usually put inside your apps's <code>ui</code> 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 <code>id</code> to make it easier to
|
||||
reference or remove it later on). If you want to insert raw html, use
|
||||
<code>ui = HTML()</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>multiple</dt>
|
||||
<dd><p>In case your selector matches more than one element,
|
||||
<code>multiple</code> determines whether Shiny should insert the UI object
|
||||
relative to all matched elements or just relative to the first
|
||||
matched element (default).</p></dd>
|
||||
|
||||
|
||||
<dt>immediate</dt>
|
||||
<dd><p>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).</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>The shiny session. Advanced use only.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -200,7 +211,7 @@ through a jQuery selector can be removed through this function.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -63,11 +63,14 @@ of milliseconds.</p>
|
||||
<dl><dt>millis</dt>
|
||||
<dd><p>Approximate milliseconds to wait before invalidating the
|
||||
current reactive context.</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>A session object. This is needed to cancel any scheduled
|
||||
invalidations after a user has ended the session. If <code>NULL</code>, then
|
||||
this invalidation will not be tied to any session, and so it will still
|
||||
occur.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -130,7 +133,7 @@ possible to stop this cycle by adding conditional logic that prevents the
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -60,6 +60,7 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>x</dt>
|
||||
<dd><p>The object to test.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -78,7 +79,7 @@
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -58,7 +58,9 @@
|
||||
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p><code>TRUE</code> if a Shiny application is currently running. Otherwise,
|
||||
|
||||
|
||||
<p><code>TRUE</code> if a Shiny application is currently running. Otherwise,
|
||||
<code>FALSE</code>.</p>
|
||||
</div>
|
||||
|
||||
@@ -74,7 +76,7 @@
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -70,6 +70,7 @@ clicked?".</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>x</dt>
|
||||
<dd><p>An expression whose truthiness value we want to determine</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -99,7 +100,7 @@ a value of <code>""</code>, so that is considered a falsy value.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -64,6 +64,7 @@ re-evaluated when they change.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>expr</dt>
|
||||
<dd><p>An expression that can access reactive values or expressions.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -143,7 +144,7 @@ calls to the reactive expression with <code>isolate()</code>.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -66,10 +66,15 @@ themselves in knitr/rmarkdown documents.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>x</dt>
|
||||
<dd><p>Object to knit_print</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Additional knit_print arguments</p></dd>
|
||||
|
||||
|
||||
<dt>inline</dt>
|
||||
<dd><p>Whether the object is printed inline.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@@ -84,7 +89,7 @@ themselves in knitr/rmarkdown documents.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -70,12 +70,17 @@ adjacent to the <code>app.R</code>/<code>server.R</code>/<code>ui.R</code> files
|
||||
<dd><p>The application directory. If <code>appDir</code> is <code>NULL</code> or
|
||||
not supplied, the nearest enclosing directory that is a Shiny app, starting
|
||||
with the current directory, is used.</p></dd>
|
||||
|
||||
|
||||
<dt>renv</dt>
|
||||
<dd><p>The environment in which the files in the <code>R/</code> directory should
|
||||
be evaluated.</p></dd>
|
||||
|
||||
|
||||
<dt>globalrenv</dt>
|
||||
<dd><p>The environment in which <code>global.R</code> should be evaluated. If
|
||||
<code>NULL</code>, <code>global.R</code> will not be evaluated at all.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -103,7 +108,7 @@ breaking it, so after running your application, you should unset option with
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -66,12 +66,17 @@ reactive variable (or <code>NULL</code> if the variable did not exist).</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>symbol</dt>
|
||||
<dd><p>Name of variable to make reactive, as a string.</p></dd>
|
||||
|
||||
|
||||
<dt>env</dt>
|
||||
<dd><p>Environment in which to create binding. Expert use only.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>None.</p>
|
||||
|
||||
|
||||
<p>None.</p>
|
||||
</div>
|
||||
|
||||
<div id="ref-examples">
|
||||
@@ -102,7 +107,7 @@ reactive variable (or <code>NULL</code> if the variable did not exist).</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -61,11 +61,16 @@
|
||||
<dl><dt>renderFunc</dt>
|
||||
<dd><p>A function that is suitable for assigning to a Shiny output
|
||||
slot.</p></dd>
|
||||
|
||||
|
||||
<dt>snapshotExclude</dt>
|
||||
<dd><p>If TRUE, exclude the output from test snapshots.</p></dd>
|
||||
|
||||
|
||||
<dt>snapshotPreprocess</dt>
|
||||
<dd><p>A function for preprocessing the value before
|
||||
taking a test snapshot.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@@ -80,7 +85,7 @@ taking a test snapshot.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -70,9 +70,13 @@ support async execution. (Shiny 1.1.0)</p>
|
||||
<dl><dt>uiFunc</dt>
|
||||
<dd><p>A function that renders Shiny UI. Must take a single argument:
|
||||
an output ID.</p></dd>
|
||||
|
||||
|
||||
<dt>renderFunc</dt>
|
||||
<dd><p>A function that is suitable for assigning to a Shiny output
|
||||
slot.</p></dd>
|
||||
|
||||
|
||||
<dt>outputArgs</dt>
|
||||
<dd><p>A list of arguments to pass to the <code>uiFunc</code>. Render
|
||||
functions should include <code>outputArgs = list()</code> in their own parameter list,
|
||||
@@ -80,18 +84,24 @@ and pass through the value to <code>markRenderFunction</code>, 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).</p></dd>
|
||||
|
||||
|
||||
<dt>cacheHint</dt>
|
||||
<dd><p>One of <code>"auto"</code>, <code>FALSE</code>, or some other information to
|
||||
identify this instance for caching using <code><a href="bindCache.html">bindCache()</a></code>. If <code>"auto"</code>, it
|
||||
will try to automatically infer caching information. If <code>FALSE</code>, do not
|
||||
allow caching for the object. Some render functions (such as <a href="renderPlot.html">renderPlot</a>)
|
||||
contain internal state that makes them unsuitable for caching.</p></dd>
|
||||
|
||||
|
||||
<dt>cacheWriteHook</dt>
|
||||
<dd><p>Used if the render function is passed to <code><a href="bindCache.html">bindCache()</a></code>.
|
||||
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 <code>renderFunc</code>, and should return the value
|
||||
to store in the cache.</p></dd>
|
||||
|
||||
|
||||
<dt>cacheReadHook</dt>
|
||||
<dd><p>Used if the render function is passed to <code><a href="bindCache.html">bindCache()</a></code>.
|
||||
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 <code><a href="createWebDependency.html">createWebDependency()</a></code> so that Shiny
|
||||
is able to serve JS and CSS resources.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>The <code>renderFunc</code> function, with annotations.</p>
|
||||
|
||||
|
||||
<p>The <code>renderFunc</code> function, with annotations.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -137,7 +150,7 @@ interface. There may be cases where <code>markRenderFunction()</code> must be us
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -66,19 +66,28 @@ HTML that may be included in Shiny UIs.</p>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>extensions</dt>
|
||||
<dd><p>Enable Github syntax extensions; defaults to <code>TRUE</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>.noWS</dt>
|
||||
<dd><p>Character vector used to omit some of the whitespace that would
|
||||
normally be written around generated HTML. Valid options include <code>before</code>,
|
||||
<code>after</code>, and <code>outside</code> (equivalent to <code>before</code> and <code>end</code>).</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Additional arguments to pass to <code><a href="https://docs.ropensci.org/commonmark/reference/commonmark.html" class="external-link">commonmark::markdown_html()</a></code>.
|
||||
These arguments are <em><a href="https://rlang.r-lib.org/reference/dyn-dots.html" class="external-link">dynamic</a></em>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>a character vector marked as HTML.</p>
|
||||
|
||||
|
||||
<p>a character vector marked as HTML.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -126,7 +135,7 @@ arguments to <code>markdown()</code> are passed as arguments to <code>markdown_h
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -66,10 +66,13 @@ default, an error).</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>expr</dt>
|
||||
<dd><p>An expression to evaluate.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>The value of <code>expr</code>.</p>
|
||||
|
||||
|
||||
<p>The value of <code>expr</code>.</p>
|
||||
</div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -88,7 +91,7 @@ default, an error).</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -70,27 +70,40 @@
|
||||
<dd><p>Maximum size of the cache, in bytes. If the cache exceeds
|
||||
this size, cached objects will be removed according to the value of the
|
||||
<code>evict</code>. Use <code>Inf</code> for no size limit. The default is 1 gigabyte.</p></dd>
|
||||
|
||||
|
||||
<dt>max_age</dt>
|
||||
<dd><p>Maximum age of files in cache before they are evicted, in
|
||||
seconds. Use <code>Inf</code> for no age limit.</p></dd>
|
||||
|
||||
|
||||
<dt>max_n</dt>
|
||||
<dd><p>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 <code>evict</code>. Use <code>Inf</code> for no limit of number of items.</p></dd>
|
||||
|
||||
|
||||
<dt>evict</dt>
|
||||
<dd><p>The eviction policy to use to decide which objects are removed
|
||||
when a cache pruning occurs. Currently, <code>"lru"</code> and <code>"fifo"</code> are supported.</p></dd>
|
||||
|
||||
|
||||
<dt>missing</dt>
|
||||
<dd><p>A value to return when <code>get(key)</code> is called but the key is not
|
||||
present in the cache. The default is a <code><a href="https://r-lib.github.io/fastmap/reference/key_missing.html" class="external-link">key_missing()</a></code> object. It is
|
||||
actually an expression that is evaluated each time there is a cache miss.
|
||||
See section Missing keys for more information.</p></dd>
|
||||
|
||||
|
||||
<dt>exec_missing</dt>
|
||||
<dd><p>Deprecated.</p></dd>
|
||||
|
||||
|
||||
<dt>logfile</dt>
|
||||
<dd><p>An optional filename or connection object to where logging
|
||||
information will be written. To log to the console, use <code><a href="https://rdrr.io/r/base/showConnections.html" class="external-link">stderr()</a></code> or
|
||||
<code><a href="https://rdrr.io/r/base/showConnections.html" class="external-link">stdout()</a></code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
</div>
|
||||
@@ -105,7 +118,7 @@ information will be written. To log to the console, use <code><a href="https://r
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -79,27 +79,42 @@ typically used when customising the <code>footer</code>.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p>UI elements for the body of the modal dialog box.</p></dd>
|
||||
|
||||
|
||||
<dt>title</dt>
|
||||
<dd><p>An optional title for the dialog.</p></dd>
|
||||
|
||||
|
||||
<dt>footer</dt>
|
||||
<dd><p>UI for footer. Use <code>NULL</code> for no footer.</p></dd>
|
||||
|
||||
|
||||
<dt>size</dt>
|
||||
<dd><p>One of <code>"s"</code> for small, <code>"m"</code> (the default) for medium,
|
||||
or <code>"l"</code> for large.</p></dd>
|
||||
|
||||
|
||||
<dt>easyClose</dt>
|
||||
<dd><p>If <code>TRUE</code>, the modal dialog can be dismissed by
|
||||
clicking outside the dialog box, or be pressing the Escape key. If
|
||||
<code>FALSE</code> (the default), the modal dialog can't be dismissed in those
|
||||
ways; instead it must be dismissed by clicking on a <code>modalButton()</code>, or
|
||||
from a call to <code><a href="showModal.html">removeModal()</a></code> on the server.</p></dd>
|
||||
|
||||
|
||||
<dt>fade</dt>
|
||||
<dd><p>If <code>FALSE</code>, the modal dialog will have no fade-in animation
|
||||
(it will simply appear rather than fade in to view).</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>The contents of the button or link--usually a text label, but
|
||||
you could also use any other HTML, like an image.</p></dd>
|
||||
|
||||
|
||||
<dt>icon</dt>
|
||||
<dd><p>An optional <code><a href="icon.html">icon()</a></code> to appear on the button.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
<div id="ref-examples">
|
||||
@@ -214,7 +229,7 @@ you could also use any other HTML, like an image.</p></dd>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -67,15 +67,22 @@ modules are easier to reuse and easier to reason about. See the article at
|
||||
<dl><dt>id</dt>
|
||||
<dd><p>An ID string that corresponds with the ID used to call the module's
|
||||
UI function.</p></dd>
|
||||
|
||||
|
||||
<dt>module</dt>
|
||||
<dd><p>A Shiny module server function.</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>Session from which to make a child scope (the default should
|
||||
almost always be used).</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>The return value, if any, from executing the module server function</p>
|
||||
|
||||
|
||||
<p>The return value, if any, from executing the module server function</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -175,7 +182,7 @@ to understand, and modules created with <code>moduleServer</code> can be tested
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -78,20 +78,28 @@ toggle a set of <code><a href="tabPanel.html">tabPanel()</a></code> elements.</p
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>title</dt>
|
||||
<dd><p>The title to display in the navbar</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p><code><a href="tabPanel.html">tabPanel()</a></code> elements to include in the page. The
|
||||
<code>navbarMenu</code> function also accepts strings, which will be used as menu
|
||||
section headers. If the string is a set of dashes like <code>"----"</code> a
|
||||
horizontal separator will be displayed in the menu.</p></dd>
|
||||
|
||||
|
||||
<dt>id</dt>
|
||||
<dd><p>If provided, you can use <code>input$</code><em><code>id</code></em> in your
|
||||
server logic to determine which of the current tabs is active. The value
|
||||
will correspond to the <code>value</code> argument that is passed to
|
||||
<code><a href="tabPanel.html">tabPanel()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>selected</dt>
|
||||
<dd><p>The <code>value</code> (or, if none was supplied, the <code>title</code>)
|
||||
of the tab that should be selected by default. If <code>NULL</code>, the first
|
||||
tab will be selected.</p></dd>
|
||||
|
||||
|
||||
<dt>position</dt>
|
||||
<dd><p>Determines whether the navbar should be displayed at the top
|
||||
of the page with normal scrolling behavior (<code>"static-top"</code>), pinned at
|
||||
@@ -100,22 +108,34 @@ the top (<code>"fixed-top"</code>), or pinned at the bottom
|
||||
<code>"fixed-bottom"</code> will cause the navbar to overlay your body content,
|
||||
unless you add padding, e.g.: <code>tags$style(type="text/css", "body
|
||||
{padding-top: 70px;}")</code></p></dd>
|
||||
|
||||
|
||||
<dt>header</dt>
|
||||
<dd><p>Tag or list of tags to display as a common header above all
|
||||
tabPanels.</p></dd>
|
||||
|
||||
|
||||
<dt>footer</dt>
|
||||
<dd><p>Tag or list of tags to display as a common footer below all
|
||||
tabPanels</p></dd>
|
||||
|
||||
|
||||
<dt>inverse</dt>
|
||||
<dd><p><code>TRUE</code> to use a dark background and light text for the
|
||||
navigation bar</p></dd>
|
||||
|
||||
|
||||
<dt>collapsible</dt>
|
||||
<dd><p><code>TRUE</code> 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)</p></dd>
|
||||
|
||||
|
||||
<dt>fluid</dt>
|
||||
<dd><p><code>TRUE</code> to use a fluid layout. <code>FALSE</code> to use a fixed
|
||||
layout.</p></dd>
|
||||
|
||||
|
||||
<dt>theme</dt>
|
||||
<dd><p>One of the following:</p><ul><li><p><code>NULL</code> (the default), which implies a "stock" build of Bootstrap 3.</p></li>
|
||||
<li><p>A <code><a href="https://rstudio.github.io/bslib/reference/bs_theme.html" class="external-link">bslib::bs_theme()</a></code> 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.</p></li
|
||||
<li><p>A character string pointing to an alternative Bootstrap stylesheet
|
||||
(normally a css file within the www directory, e.g. <code>www/bootstrap.css</code>).</p></li>
|
||||
</ul></dd>
|
||||
|
||||
|
||||
<dt>windowTitle</dt>
|
||||
<dd><p>the browser window title (as a character string). The
|
||||
default value, <code>NA</code>, means to use any character strings that appear in
|
||||
<code>title</code> (if none are found, the host URL of the page is displayed by
|
||||
default).</p></dd>
|
||||
|
||||
|
||||
<dt>lang</dt>
|
||||
<dd><p>ISO 639-1 language code for the HTML page, such as "en" or "ko".
|
||||
This will be used as the lang in the <code><html></code> tag, as in <code><html lang="en"></code>.
|
||||
The default (NULL) results in an empty string.</p></dd>
|
||||
|
||||
|
||||
<dt>menuName</dt>
|
||||
<dd><p>A name that identifies this <code>navbarMenu</code>. This
|
||||
is needed if you want to insert/remove or show/hide an entire
|
||||
<code>navbarMenu</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>icon</dt>
|
||||
<dd><p>Optional icon to appear on a <code>navbarMenu</code> tab.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function.</p>
|
||||
|
||||
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -176,24 +207,24 @@ example below).</p>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="navbar-header"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <span class="navbar-brand">App Title</span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav navbar-nav" data-tabsetid="1343"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav navbar-nav" data-tabsetid="6984"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li class="active"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-1343-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot">Plot</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-6984-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot">Plot</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-1343-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary">Summary</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-6984-2" data-toggle="tab" data-bs-toggle="tab" data-value="Summary">Summary</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-1343-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table">Table</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-6984-3" data-toggle="tab" data-bs-toggle="tab" data-value="Table">Table</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </ul></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </nav></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="container-fluid"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="1343"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-value="Plot" id="tab-1343-1"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Summary" id="tab-1343-2"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Table" id="tab-1343-3"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="6984"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-value="Plot" id="tab-6984-1"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Summary" id="tab-6984-2"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Table" id="tab-6984-3"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-in"></span>
|
||||
@@ -211,23 +242,23 @@ example below).</p>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="navbar-header"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <span class="navbar-brand">App Title</span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav navbar-nav" data-tabsetid="9821"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav navbar-nav" data-tabsetid="1971"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li class="active"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-9821-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot">Plot</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-1971-1" data-toggle="tab" data-bs-toggle="tab" data-value="Plot">Plot</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li class="dropdown"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#" class="dropdown-toggle" data-toggle="dropdown" data-bs-toggle="dropdown" data-value="More"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> More</span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <b class="caret"></b></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="dropdown-menu" data-tabsetid="2901"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="dropdown-menu" data-tabsetid="7811"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-2901-1" data-toggle="tab" data-bs-toggle="tab" data-value="Summary">Summary</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-7811-1" data-toggle="tab" data-bs-toggle="tab" data-value="Summary">Summary</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li class="divider"></li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li class="dropdown-header">Section header</li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-2901-4" data-toggle="tab" data-bs-toggle="tab" data-value="Table">Table</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-7811-4" data-toggle="tab" data-bs-toggle="tab" data-value="Table">Table</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </ul></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
@@ -235,10 +266,10 @@ example below).</p>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </nav></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="container-fluid"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="9821"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-value="Plot" id="tab-9821-1"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Summary" id="tab-2901-1"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Table" id="tab-2901-4"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="1971"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-value="Plot" id="tab-1971-1"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Summary" id="tab-7811-1"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Table" id="tab-7811-4"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
</code></pre></div>
|
||||
@@ -255,7 +286,7 @@ example below).</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -71,30 +71,45 @@ which navigate to a set of tabPanels displayed to the right.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>...</dt>
|
||||
<dd><p><code><a href="tabPanel.html">tabPanel()</a></code> elements to include in the navlist</p></dd>
|
||||
|
||||
|
||||
<dt>id</dt>
|
||||
<dd><p>If provided, you can use <code>input$</code><em><code>id</code></em> in your
|
||||
server logic to determine which of the current navlist items is active. The
|
||||
value will correspond to the <code>value</code> argument that is passed to
|
||||
<code><a href="tabPanel.html">tabPanel()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>selected</dt>
|
||||
<dd><p>The <code>value</code> (or, if none was supplied, the <code>title</code>)
|
||||
of the navigation item that should be selected by default. If <code>NULL</code>,
|
||||
the first navigation will be selected.</p></dd>
|
||||
|
||||
|
||||
<dt>header</dt>
|
||||
<dd><p>Tag or list of tags to display as a common header above all
|
||||
tabPanels.</p></dd>
|
||||
|
||||
|
||||
<dt>footer</dt>
|
||||
<dd><p>Tag or list of tags to display as a common footer below all
|
||||
tabPanels</p></dd>
|
||||
|
||||
|
||||
<dt>well</dt>
|
||||
<dd><p><code>TRUE</code> to place a well (gray rounded rectangle) around the
|
||||
navigation list.</p></dd>
|
||||
|
||||
|
||||
<dt>fluid</dt>
|
||||
<dd><p><code>TRUE</code> to use fluid layout; <code>FALSE</code> to use fixed
|
||||
layout.</p></dd>
|
||||
|
||||
|
||||
<dt>widths</dt>
|
||||
<dd><p>Column widths of the navigation list and tabset content areas
|
||||
respectively.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -127,24 +142,24 @@ doesn't support separators.</p>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <h2>Application Title</h2></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="row"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="col-sm-4 well"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav nav-pills nav-stacked" data-tabsetid="3404"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <ul class="nav nav-pills nav-stacked" data-tabsetid="2544"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li class="navbar-brand">Header</li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li class="active"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-3404-2" data-toggle="tab" data-bs-toggle="tab" data-value="First">First</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-2544-2" data-toggle="tab" data-bs-toggle="tab" data-value="First">First</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-3404-3" data-toggle="tab" data-bs-toggle="tab" data-value="Second">Second</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-2544-3" data-toggle="tab" data-bs-toggle="tab" data-value="Second">Second</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-3404-4" data-toggle="tab" data-bs-toggle="tab" data-value="Third">Third</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <a href="#tab-2544-4" data-toggle="tab" data-bs-toggle="tab" data-value="Third">Third</a></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </li></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </ul></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="col-sm-8"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="3404"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-value="First" id="tab-3404-2"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Second" id="tab-3404-3"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Third" id="tab-3404-4"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-content" data-tabsetid="2544"></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane active" data-value="First" id="tab-2544-2"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Second" id="tab-2544-3"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <div class="tab-pane" data-value="Third" id="tab-2544-4"></div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> </div></span>
|
||||
@@ -163,7 +178,7 @@ doesn't support separators.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -68,23 +68,38 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
||||
|
||||
|
||||
<dt>value</dt>
|
||||
<dd><p>Initial value.</p></dd>
|
||||
|
||||
|
||||
<dt>min</dt>
|
||||
<dd><p>Minimum allowed value</p></dd>
|
||||
|
||||
|
||||
<dt>max</dt>
|
||||
<dd><p>Maximum allowed value</p></dd>
|
||||
|
||||
|
||||
<dt>step</dt>
|
||||
<dd><p>Interval to use when stepping between min and max</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A numeric input control that can be added to a UI definition.</p>
|
||||
|
||||
|
||||
<p>A numeric input control that can be added to a UI definition.</p>
|
||||
</div>
|
||||
<div id="server-value">
|
||||
<h2>Server value</h2>
|
||||
@@ -141,7 +156,7 @@ see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -72,41 +72,62 @@
|
||||
<dl><dt>x</dt>
|
||||
<dd><p>An expression (quoted or unquoted). Any return value will be
|
||||
ignored.</p></dd>
|
||||
|
||||
|
||||
<dt>env</dt>
|
||||
<dd><p>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 <code>x</code> is a quosure and <code>quoted</code> is <code>TRUE</code>,
|
||||
then <code>env</code> is ignored.</p></dd>
|
||||
|
||||
|
||||
<dt>quoted</dt>
|
||||
<dd><p>If it is <code>TRUE</code>, then the <code><a href="https://rdrr.io/r/base/substitute.html" class="external-link">quote()</a></code>ed value of <code>x</code>
|
||||
will be used when <code>x</code> is evaluated. If <code>x</code> is a quosure and you
|
||||
would like to use its expression as a value for <code>x</code>, then you must set
|
||||
<code>quoted</code> to <code>TRUE</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Not used.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>A label for the observer, useful for debugging.</p></dd>
|
||||
|
||||
|
||||
<dt>suspended</dt>
|
||||
<dd><p>If <code>TRUE</code>, start the observer in a suspended state. If
|
||||
<code>FALSE</code> (the default), start in a non-suspended state.</p></dd>
|
||||
|
||||
|
||||
<dt>priority</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>domain</dt>
|
||||
<dd><p>See <a href="domains.html">domains</a>.</p></dd>
|
||||
|
||||
|
||||
<dt>autoDestroy</dt>
|
||||
<dd><p>If <code>TRUE</code> (the default), the observer will be
|
||||
automatically destroyed when its domain (if any) ends.</p></dd>
|
||||
|
||||
|
||||
<dt>..stacktraceon</dt>
|
||||
<dd><p>Advanced use only. For stack manipulation purposes; see
|
||||
<code><a href="stacktrace.html">stacktrace()</a></code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>An observer reference class object. This object has the following
|
||||
|
||||
|
||||
<p>An observer reference class object. This object has the following
|
||||
methods:</p><dl><dt><code>suspend()</code></dt>
|
||||
<dd><p>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).</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -101,80 +101,117 @@ renderText() and renderPlot()).'><meta property="og:image" content="/logo.png"><
|
||||
this can be a simple reactive value like <code>input$click</code>, a call to a
|
||||
reactive expression like <code>dataset()</code>, or even a complex expression
|
||||
inside curly braces</p></dd>
|
||||
|
||||
|
||||
<dt>handlerExpr</dt>
|
||||
<dd><p>The expression to call whenever <code>eventExpr</code> is
|
||||
invalidated. This should be a side-effect-producing action (the return
|
||||
value will be ignored). It will be executed within an <code><a href="isolate.html">isolate()</a></code>
|
||||
scope.</p></dd>
|
||||
|
||||
|
||||
<dt>event.env</dt>
|
||||
<dd><p>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 <code>eventExpr</code> is a quosure and <code>event.quoted</code> is <code>TRUE</code>,
|
||||
then <code>event.env</code> is ignored.</p></dd>
|
||||
|
||||
|
||||
<dt>event.quoted</dt>
|
||||
<dd><p>If it is <code>TRUE</code>, then the <code><a href="https://rdrr.io/r/base/substitute.html" class="external-link">quote()</a></code>ed value of <code>eventExpr</code>
|
||||
will be used when <code>eventExpr</code> is evaluated. If <code>eventExpr</code> is a quosure and you
|
||||
would like to use its expression as a value for <code>eventExpr</code>, then you must set
|
||||
<code>event.quoted</code> to <code>TRUE</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>handler.env</dt>
|
||||
<dd><p>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 <code>handlerExpr</code> is a quosure and <code>handler.quoted</code> is <code>TRUE</code>,
|
||||
then <code>handler.env</code> is ignored.</p></dd>
|
||||
|
||||
|
||||
<dt>handler.quoted</dt>
|
||||
<dd><p>If it is <code>TRUE</code>, then the <code><a href="https://rdrr.io/r/base/substitute.html" class="external-link">quote()</a></code>ed value of <code>handlerExpr</code>
|
||||
will be used when <code>handlerExpr</code> is evaluated. If <code>handlerExpr</code> is a quosure and you
|
||||
would like to use its expression as a value for <code>handlerExpr</code>, then you must set
|
||||
<code>handler.quoted</code> to <code>TRUE</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Currently not used.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>A label for the observer or reactive, useful for debugging.</p></dd>
|
||||
|
||||
|
||||
<dt>suspended</dt>
|
||||
<dd><p>If <code>TRUE</code>, start the observer in a suspended state. If
|
||||
<code>FALSE</code> (the default), start in a non-suspended state.</p></dd>
|
||||
|
||||
|
||||
<dt>priority</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>domain</dt>
|
||||
<dd><p>See <a href="domains.html">domains</a>.</p></dd>
|
||||
|
||||
|
||||
<dt>autoDestroy</dt>
|
||||
<dd><p>If <code>TRUE</code> (the default), the observer will be
|
||||
automatically destroyed when its domain (if any) ends.</p></dd>
|
||||
|
||||
|
||||
<dt>ignoreNULL</dt>
|
||||
<dd><p>Whether the action should be triggered (or value
|
||||
calculated, in the case of <code>eventReactive</code>) when the input is
|
||||
<code>NULL</code>. See Details.</p></dd>
|
||||
|
||||
|
||||
<dt>ignoreInit</dt>
|
||||
<dd><p>If <code>TRUE</code>, then, when this <code>observeEvent</code> is
|
||||
first created/initialized, ignore the <code>handlerExpr</code> (the second
|
||||
argument), whether it is otherwise supposed to run or not. The default is
|
||||
<code>FALSE</code>. See Details.</p></dd>
|
||||
|
||||
|
||||
<dt>once</dt>
|
||||
<dd><p>Whether this <code>observeEvent</code> should be immediately destroyed
|
||||
after the first time that the code in <code>handlerExpr</code> is run. This
|
||||
pattern is useful when you want to subscribe to a event that should only
|
||||
happen once.</p></dd>
|
||||
|
||||
|
||||
<dt>valueExpr</dt>
|
||||
<dd><p>The expression that produces the return value of the
|
||||
<code>eventReactive</code>. It will be executed within an <code><a href="isolate.html">isolate()</a></code>
|
||||
scope.</p></dd>
|
||||
|
||||
|
||||
<dt>value.env</dt>
|
||||
<dd><p>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 <code>valueExpr</code> is a quosure and <code>value.quoted</code> is <code>TRUE</code>,
|
||||
then <code>value.env</code> is ignored.</p></dd>
|
||||
|
||||
|
||||
<dt>value.quoted</dt>
|
||||
<dd><p>If it is <code>TRUE</code>, then the <code><a href="https://rdrr.io/r/base/substitute.html" class="external-link">quote()</a></code>ed value of <code>valueExpr</code>
|
||||
will be used when <code>valueExpr</code> is evaluated. If <code>valueExpr</code> is a quosure and you
|
||||
would like to use its expression as a value for <code>valueExpr</code>, then you must set
|
||||
<code>value.quoted</code> to <code>TRUE</code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p><code>observeEvent</code> returns an observer reference class object (see
|
||||
|
||||
|
||||
<p><code>observeEvent</code> returns an observer reference class object (see
|
||||
<code><a href="observe.html">observe()</a></code>). <code>eventReactive</code> returns a reactive expression
|
||||
object (see <code><a href="reactive.html">reactive()</a></code>).</p>
|
||||
</div>
|
||||
@@ -361,7 +398,7 @@ created (because <code>ignoreInit = TRUE</code>). After that,
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -97,8 +97,11 @@ browser.</p></li>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>fun</dt>
|
||||
<dd><p>A callback function which takes one argument.</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>A shiny session object.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -281,7 +284,7 @@ module's inputs and values.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -72,12 +72,17 @@ registers a function to be called after the client has disconnected.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>fun</dt>
|
||||
<dd><p>A callback function.</p></dd>
|
||||
|
||||
|
||||
<dt>once</dt>
|
||||
<dd><p>Should the function be run once, and then cleared, or should it
|
||||
re-run each time the event occurs. (Only for <code>onFlush</code> and
|
||||
<code>onFlushed</code>.)</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>A shiny session object.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -103,7 +108,7 @@ invoked when the application exits, or when a session ends.</p></div>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -64,6 +64,8 @@ session ends (when a client disconnects).</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>fun</dt>
|
||||
<dd><p>A function that will be called after the app has finished running.</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>A scope for when the callback will run. If <code>onStop</code> 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 <code>NULL</code>, it is the same as
|
||||
calling <code>onStop</code> outside of the server function, and the callback will
|
||||
be invoked when the application exits.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A function which, if invoked, will cancel the callback.</p>
|
||||
|
||||
|
||||
<p>A function which, if invoked, will cancel the callback.</p>
|
||||
</div>
|
||||
<div id="see-also">
|
||||
<h2>See also</h2>
|
||||
@@ -149,7 +154,7 @@ the session level only.</p></div>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -73,10 +73,15 @@ with higher priority values will execute before those with lower values.</p></li
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>x</dt>
|
||||
<dd><p>A shinyoutput object (typically <code>output</code>).</p></dd>
|
||||
|
||||
|
||||
<dt>name</dt>
|
||||
<dd><p>The name of an output observer in the shinyoutput object.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Options to set for the output observer.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
<div id="ref-examples">
|
||||
@@ -109,7 +114,7 @@ with higher priority values will execute before those with lower values.</p></li
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -60,14 +60,21 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>headerPanel</dt>
|
||||
<dd><p>The <a href="headerPanel.html">headerPanel</a> with the application title</p></dd>
|
||||
|
||||
|
||||
<dt>sidebarPanel</dt>
|
||||
<dd><p>The <a href="sidebarLayout.html">sidebarPanel</a> containing input controls</p></dd>
|
||||
|
||||
|
||||
<dt>mainPanel</dt>
|
||||
<dd><p>The <a href="sidebarLayout.html">mainPanel</a> containing outputs</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function</p>
|
||||
|
||||
|
||||
<p>A UI definition that can be passed to the <a href="shinyUI.html">shinyUI</a> function</p>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
@@ -82,7 +89,7 @@
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -60,6 +60,8 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>str</dt>
|
||||
<dd><p>The query string. It can have a leading <code>"?"</code> or not.</p></dd>
|
||||
|
||||
|
||||
<dt>nested</dt>
|
||||
<dd><p>Whether to parse the query string of as a nested list when it
|
||||
contains pairs of square brackets <code>[]</code>. For example, the query
|
||||
@@ -67,6 +69,7 @@ contains pairs of square brackets <code>[]</code>. For example, the query
|
||||
list(i1 = list(j1 = 'x')), b = list(i1 = list(j1 = 'y'), i2 = list(j1 =
|
||||
'z')))</code> when <code>nested = TRUE</code>, and <code>list(`a[i1][j1]` = 'x',
|
||||
`b[i1][j1]` = 'y', `b[i2][j1]` = 'z')</code> when <code>nested = FALSE</code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
<div id="ref-examples">
|
||||
@@ -114,7 +117,7 @@ list(i1 = list(j1 = 'x')), b = list(i1 = list(j1 = 'y'), i2 = list(j1 =
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -60,21 +60,32 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
||||
|
||||
|
||||
<dt>value</dt>
|
||||
<dd><p>Initial value.</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>placeholder</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A text input control that can be added to a UI definition.</p>
|
||||
|
||||
|
||||
<p>A text input control that can be added to a UI definition.</p>
|
||||
</div>
|
||||
<div id="server-value">
|
||||
<h2>Server value</h2>
|
||||
@@ -135,7 +146,7 @@ unless <code>value</code> is provided.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -82,6 +82,8 @@ application page.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>outputId</dt>
|
||||
<dd><p>output variable to read the plot/image from.</p></dd>
|
||||
|
||||
|
||||
<dt>width, height</dt>
|
||||
<dd><p>Image width/height. Must be a valid CSS unit (like
|
||||
<code>"100%"</code>, <code>"400px"</code>, <code>"auto"</code>) or a number, which will be
|
||||
@@ -90,6 +92,8 @@ ignored when <code>inline = TRUE</code>, in which case the width/height of a plo
|
||||
must be specified in <code><a href="renderPlot.html">renderPlot()</a></code>. Note that, for height, using
|
||||
<code>"auto"</code> or <code>"100%"</code> generally will not work as expected,
|
||||
because of how height is computed with HTML/CSS.</p></dd>
|
||||
|
||||
|
||||
<dt>click</dt>
|
||||
<dd><p>This can be <code>NULL</code> (the default), a string, or an object
|
||||
created by the <code><a href="clickOpts.html">clickOpts()</a></code> 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 <code>input$plot_click</code>. The value will be
|
||||
a named list with <code>x</code> and <code>y</code> elements indicating the mouse
|
||||
position.</p></dd>
|
||||
|
||||
|
||||
<dt>dblclick</dt>
|
||||
<dd><p>This is just like the <code>click</code> argument, but for
|
||||
double-click events.</p></dd>
|
||||
|
||||
|
||||
<dt>hover</dt>
|
||||
<dd><p>Similar to the <code>click</code> argument, this can be <code>NULL</code>
|
||||
(the default), a string, or an object created by the
|
||||
@@ -111,6 +119,8 @@ value will be accessible via <code>input$plot_hover</code>. The value will be a
|
||||
named list with <code>x</code> and <code>y</code> elements indicating the mouse
|
||||
position. To control the hover time or hover delay type, you must use
|
||||
<code><a href="clickOpts.html">hoverOpts()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>brush</dt>
|
||||
<dd><p>Similar to the <code>click</code> argument, this can be <code>NULL</code>
|
||||
(the default), a string, or an object created by the
|
||||
@@ -126,13 +136,18 @@ behavior, use <code><a href="brushOpts.html">brushOpts()</a></code>. Multiple
|
||||
<code>imageOutput</code>/<code>plotOutput</code> calls may share the same <code>id</code>
|
||||
value; brushing one image or plot will cause any other brushes with the
|
||||
same <code>id</code> to disappear.</p></dd>
|
||||
|
||||
|
||||
<dt>inline</dt>
|
||||
<dd><p>use an inline (<code><a href="https://rdrr.io/pkg/htmltools/man/builder.html" class="external-link">span()</a></code>) or block container (<code><a href="https://rdrr.io/pkg/htmltools/man/builder.html" class="external-link">div()</a></code>)
|
||||
for the output</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A plot or image output element that can be included in a panel.</p>
|
||||
|
||||
|
||||
<p>A plot or image output element that can be included in a panel.</p>
|
||||
</div>
|
||||
<div id="note">
|
||||
<h2>Note</h2>
|
||||
@@ -341,7 +356,7 @@ properly scaled to the data space.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -73,20 +73,31 @@ way.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>func</dt>
|
||||
<dd><p>A function that generates a plot.</p></dd>
|
||||
|
||||
|
||||
<dt>filename</dt>
|
||||
<dd><p>The name of the output file. Defaults to a temp file with
|
||||
extension <code>.png</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>Width in pixels.</p></dd>
|
||||
|
||||
|
||||
<dt>height</dt>
|
||||
<dd><p>Height in pixels.</p></dd>
|
||||
|
||||
|
||||
<dt>res</dt>
|
||||
<dd><p>Resolution in pixels per inch. This value is passed to
|
||||
<code><a href="https://rdrr.io/r/grDevices/png.html" class="external-link">grDevices::png()</a></code>. Note that this affects the resolution of PNG rendering in
|
||||
R; it won't change the actual ppi of the browser.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Arguments to be passed through to <code><a href="https://rdrr.io/r/grDevices/png.html" class="external-link">grDevices::png()</a></code>.
|
||||
These can be used to set the width, height, background color, etc.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -112,7 +123,7 @@ antialias some point shapes, resulting in poor quality output.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -69,23 +69,35 @@
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>inputId</dt>
|
||||
<dd><p>The <code>input</code> slot that will be used to access the value.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>Display label for the control, or <code>NULL</code> for no label.</p></dd>
|
||||
|
||||
|
||||
<dt>choices</dt>
|
||||
<dd><p>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 <code>choiceNames</code> and <code>choiceValues</code> must not
|
||||
be provided, and vice-versa. The values should be strings; other types
|
||||
(such as logicals and numbers) will be coerced to strings.</p></dd>
|
||||
|
||||
|
||||
<dt>selected</dt>
|
||||
<dd><p>The initially selected value. If not specified, then it
|
||||
defaults to the first item in <code>choices</code>. To start with no items selected,
|
||||
use <code>character(0)</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>inline</dt>
|
||||
<dd><p>If <code>TRUE</code>, render the choices inline (i.e. horizontally)</p></dd>
|
||||
|
||||
|
||||
<dt>width</dt>
|
||||
<dd><p>The width of the input, e.g. <code>'400px'</code>, or <code>'100%'</code>;
|
||||
see <code><a href="https://rdrr.io/pkg/htmltools/man/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
||||
|
||||
|
||||
<dt>choiceNames, choiceValues</dt>
|
||||
<dd><p>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 <code>choices</code> <em>must not</em> be provided. The advantage of using b
|
||||
over a named list for <code>choices</code> is that <code>choiceNames</code> allows any type of UI
|
||||
object to be passed through (tag objects, icons, HTML code, ...), instead
|
||||
of just simple text. See Examples.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A set of radio buttons that can be added to a UI definition.</p>
|
||||
|
||||
|
||||
<p>A set of radio buttons that can be added to a UI definition.</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -199,7 +214,7 @@ having the first of your choices be <code>c("None selected" = "")</code>.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -72,29 +72,44 @@ reactive expression is a expression whose result will change over time.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>x</dt>
|
||||
<dd><p>For <code>is.reactive()</code>, an object to test. For <code>reactive()</code>, an expression. When passing in a <code><a href="https://rlang.r-lib.org/reference/defusing-advanced.html" class="external-link">quo()</a></code>sure with <code>reactive()</code>, remember to use <code><a href="https://rlang.r-lib.org/reference/inject.html" class="external-link">rlang::inject()</a></code> to distinguish that you are passing in the content of your quosure, not the expression of the quosure.</p></dd>
|
||||
|
||||
|
||||
<dt>env</dt>
|
||||
<dd><p>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 <code>x</code> is a quosure and <code>quoted</code> is <code>TRUE</code>,
|
||||
then <code>env</code> is ignored.</p></dd>
|
||||
|
||||
|
||||
<dt>quoted</dt>
|
||||
<dd><p>If it is <code>TRUE</code>, then the <code><a href="https://rdrr.io/r/base/substitute.html" class="external-link">quote()</a></code>ed value of <code>x</code>
|
||||
will be used when <code>x</code> is evaluated. If <code>x</code> is a quosure and you
|
||||
would like to use its expression as a value for <code>x</code>, then you must set
|
||||
<code>quoted</code> to <code>TRUE</code>.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Not used.</p></dd>
|
||||
|
||||
|
||||
<dt>label</dt>
|
||||
<dd><p>A label for the reactive expression, useful for debugging.</p></dd>
|
||||
|
||||
|
||||
<dt>domain</dt>
|
||||
<dd><p>See <a href="domains.html">domains</a>.</p></dd>
|
||||
|
||||
|
||||
<dt>..stacktraceon</dt>
|
||||
<dd><p>Advanced use only. For stack manipulation purposes; see
|
||||
<code><a href="stacktrace.html">stacktrace()</a></code>.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>a function, wrapped in a S3 class "reactive"</p>
|
||||
|
||||
|
||||
<p>a function, wrapped in a S3 class "reactive"</p>
|
||||
</div>
|
||||
<div id="details">
|
||||
<h2>Details</h2>
|
||||
@@ -130,7 +145,7 @@ more information about reactive expressions.</p>
|
||||
<span class="r-in"><span class="fu"><a href="isolate.html">isolate</a></span><span class="op">(</span><span class="fu">reactiveC</span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> <span style="font-weight: bold;"><quosure></span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> expr: <span style="color: #0000BB;">^values$A + 2</span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> env: <span style="color: #0000BB;">0x559383093270</span></span>
|
||||
<span class="r-out co"><span class="r-pr">#></span> env: <span style="color: #0000BB;">0x560129f1bce0</span></span>
|
||||
<span class="r-in"></span>
|
||||
<span class="r-in"><span class="co"># Instead, the quosure should be `rlang::inject()`ed</span></span>
|
||||
<span class="r-in"><span class="va">reactiveD</span> <span class="op"><-</span> <span class="fu">rlang</span><span class="fu">::</span><span class="fu"><a href="https://rlang.r-lib.org/reference/inject.html" class="external-link">inject</a></span><span class="op">(</span><span class="fu">reactive</span><span class="op">(</span><span class="op">!</span><span class="op">!</span><span class="va">myquo</span><span class="op">)</span><span class="op">)</span></span>
|
||||
@@ -159,7 +174,7 @@ more information about reactive expressions.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -62,6 +62,7 @@ at the console, for the purposes of experimentation and learning.</p>
|
||||
<h2>Arguments</h2>
|
||||
<dl><dt>enabled</dt>
|
||||
<dd><p>Turn console reactivity on or off?</p></dd>
|
||||
|
||||
</dl></div>
|
||||
|
||||
<div id="ref-examples">
|
||||
@@ -88,7 +89,7 @@ at the console, for the purposes of experimentation and learning.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
@@ -64,25 +64,36 @@ contents of the file.</p>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>session</dt>
|
||||
<dd><p>The user session to associate this file reader with, or
|
||||
<code>NULL</code> if none. If non-null, the reader will automatically stop when
|
||||
the session ends.</p></dd>
|
||||
|
||||
|
||||
<dt>filePath</dt>
|
||||
<dd><p>The file path to poll against and to pass to <code>readFunc</code>.
|
||||
This can either be a single-element character vector, or a function that
|
||||
returns one.</p></dd>
|
||||
|
||||
|
||||
<dt>readFunc</dt>
|
||||
<dd><p>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.</p></dd>
|
||||
|
||||
|
||||
<dt>...</dt>
|
||||
<dd><p>Any additional arguments to pass to <code>readFunc</code> whenever it is
|
||||
invoked.</p></dd>
|
||||
|
||||
</dl></div>
|
||||
<div id="value">
|
||||
<h2>Value</h2>
|
||||
<p>A reactive expression that returns the contents of the file, and
|
||||
|
||||
|
||||
<p>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).</p>
|
||||
</div>
|
||||
@@ -136,7 +147,7 @@ reactive values and reactive expressions.</p>
|
||||
</div>
|
||||
|
||||
<div class="pkgdown">
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.3.</p>
|
||||
<p></p><p>Site built with <a href="https://pkgdown.r-lib.org/" class="external-link">pkgdown</a> 2.0.4.</p>
|
||||
</div>
|
||||
|
||||
</footer></div>
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user