mirror of
https://github.com/rstudio/shiny.git
synced 2026-04-29 03:00:45 -04:00
244 lines
18 KiB
HTML
244 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1.0"><title>Select variables from a data frame — varSelectInput • shiny</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><!-- jquery --><script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script><!-- Bootstrap --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous"><script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script><!-- bootstrap-toc --><link rel="stylesheet" href="../bootstrap-toc.css"><script src="../bootstrap-toc.js"></script><!-- Font Awesome icons --><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous"><link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous"><!-- clipboard.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script><!-- headroom.js --><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script><!-- pkgdown --><link href="../pkgdown.css" rel="stylesheet"><script src="../pkgdown.js"></script><meta property="og:title" content="Select variables from a data frame — varSelectInput"><meta property="og:description" content="Create a select list that can be used to choose a single or multiple items
|
|
from the column names of a data frame."><meta property="og:image" content="/logo.png"><!-- mathjax --><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script><!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
|
|
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
|
|
<![endif]--></head><body data-spy="scroll" data-target="#toc">
|
|
|
|
|
|
<div class="container template-reference-topic">
|
|
<header><div class="navbar navbar-default navbar-fixed-top" role="navigation">
|
|
<div class="container">
|
|
<div class="navbar-header">
|
|
<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
|
|
<span class="sr-only">Toggle navigation</span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
<span class="icon-bar"></span>
|
|
</button>
|
|
<span class="navbar-brand">
|
|
<a class="navbar-link" href="../index.html">shiny</a>
|
|
<span class="version label label-default" data-toggle="tooltip" data-placement="bottom" title="">1.7.3.9001</span>
|
|
</span>
|
|
</div>
|
|
|
|
<div id="navbar" class="navbar-collapse collapse">
|
|
<ul class="nav navbar-nav"><li>
|
|
<a href="../reference/index.html">Reference</a>
|
|
</li>
|
|
<li>
|
|
<a href="../news/index.html">Changelog</a>
|
|
</li>
|
|
</ul><ul class="nav navbar-nav navbar-right"><li>
|
|
<a href="https://github.com/rstudio/shiny/" class="external-link">
|
|
<span class="fab fa-github fa-lg"></span>
|
|
|
|
</a>
|
|
</li>
|
|
</ul></div><!--/.nav-collapse -->
|
|
</div><!--/.container -->
|
|
</div><!--/.navbar -->
|
|
|
|
|
|
|
|
</header><div class="row">
|
|
<div class="col-md-9 contents">
|
|
<div class="page-header">
|
|
<h1>Select variables from a data frame</h1>
|
|
<small class="dont-index">Source: <a href="https://github.com/rstudio/shiny/blob/HEAD/R/input-select.R" class="external-link"><code>R/input-select.R</code></a></small>
|
|
<div class="hidden name"><code>varSelectInput.Rd</code></div>
|
|
</div>
|
|
|
|
<div class="ref-description">
|
|
<p>Create a select list that can be used to choose a single or multiple items
|
|
from the column names of a data frame.</p>
|
|
</div>
|
|
|
|
<div id="ref-usage">
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">varSelectInput</span><span class="op">(</span></span>
|
|
<span> <span class="va">inputId</span>,</span>
|
|
<span> <span class="va">label</span>,</span>
|
|
<span> <span class="va">data</span>,</span>
|
|
<span> selected <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> multiple <span class="op">=</span> <span class="cn">FALSE</span>,</span>
|
|
<span> selectize <span class="op">=</span> <span class="cn">TRUE</span>,</span>
|
|
<span> width <span class="op">=</span> <span class="cn">NULL</span>,</span>
|
|
<span> size <span class="op">=</span> <span class="cn">NULL</span></span>
|
|
<span><span class="op">)</span></span>
|
|
<span></span>
|
|
<span><span class="fu">varSelectizeInput</span><span class="op">(</span><span class="va">inputId</span>, <span class="va">...</span>, options <span class="op">=</span> <span class="cn">NULL</span>, width <span class="op">=</span> <span class="cn">NULL</span><span class="op">)</span></span></code></pre></div>
|
|
</div>
|
|
|
|
<div id="arguments">
|
|
<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>data</dt>
|
|
<dd><p>A data frame. Used to retrieve the column names as choices for a <code><a href="selectInput.html">selectInput()</a></code></p></dd>
|
|
|
|
|
|
<dt>selected</dt>
|
|
<dd><p>The initially selected value (or multiple values if <code>multiple = TRUE</code>). If not specified then defaults to the first value for
|
|
single-select lists and no values for multiple select lists.</p></dd>
|
|
|
|
|
|
<dt>multiple</dt>
|
|
<dd><p>Is selection of multiple items allowed?</p></dd>
|
|
|
|
|
|
<dt>selectize</dt>
|
|
<dd><p>Whether to use <span class="pkg">selectize.js</span> or not.</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://rstudio.github.io/htmltools/reference/validateCssUnit.html" class="external-link">validateCssUnit()</a></code>.</p></dd>
|
|
|
|
|
|
<dt>size</dt>
|
|
<dd><p>Number of items to show in the selection box; a larger number
|
|
will result in a taller box. Not compatible with <code>selectize=TRUE</code>.
|
|
Normally, when <code>multiple=FALSE</code>, a select input will be a drop-down list,
|
|
but when <code>size</code> is set, it will be a box instead.</p></dd>
|
|
|
|
|
|
<dt>...</dt>
|
|
<dd><p>Arguments passed to <code>varSelectInput()</code>.</p></dd>
|
|
|
|
|
|
<dt>options</dt>
|
|
<dd><p>A list of options. See the documentation of <span class="pkg">selectize.js</span>
|
|
for possible options (character option values inside <code><a href="https://rdrr.io/r/base/AsIs.html" class="external-link">base::I()</a></code> will
|
|
be treated as literal JavaScript code; see <code><a href="renderDataTable.html">renderDataTable()</a></code>
|
|
for details).</p></dd>
|
|
|
|
</dl></div>
|
|
<div id="value">
|
|
<h2>Value</h2>
|
|
|
|
|
|
<p>A variable select list control that can be added to a UI definition.</p>
|
|
</div>
|
|
<div id="details">
|
|
<h2>Details</h2>
|
|
<p>By default, <code>varSelectInput()</code> and <code><a href="selectInput.html">selectizeInput()</a></code> use the
|
|
JavaScript library <span class="pkg">selectize.js</span>
|
|
(<a href="https://github.com/selectize/selectize.js" class="external-link">https://github.com/selectize/selectize.js</a>) to instead of the basic
|
|
select input element. To use the standard HTML select input element, use
|
|
<code><a href="selectInput.html">selectInput()</a></code> with <code>selectize=FALSE</code>.</p>
|
|
</div>
|
|
<div id="note">
|
|
<h2>Note</h2>
|
|
<p>The variable selectize input created from <code>varSelectizeInput()</code> allows
|
|
deletion of the selected option even in a single select input, which will
|
|
return an empty string as its value. This is the default behavior of
|
|
<span class="pkg">selectize.js</span>. However, the selectize input created from
|
|
<code>selectInput(..., selectize = TRUE)</code> will ignore the empty string
|
|
value when it is a single choice input and the empty string is not in the
|
|
<code>choices</code> argument. This is to keep compatibility with
|
|
<code>selectInput(..., selectize = FALSE)</code>.</p>
|
|
</div>
|
|
<div id="server-value">
|
|
<h2>Server value</h2>
|
|
|
|
|
|
<p>The resulting server <code>input</code> value will be returned as:</p><ul><li><p>A symbol if <code>multiple = FALSE</code>. The <code>input</code> value should be
|
|
used with rlang's <code><a href="https://rlang.r-lib.org/reference/injection-operator.html" class="external-link">rlang::!!()</a></code>. For example,
|
|
<code>ggplot2::aes(!!input$variable)</code>.</p></li>
|
|
<li><p>A list of symbols if <code>multiple = TRUE</code>. The <code>input</code> value
|
|
should be used with rlang's <code><a href="https://rlang.r-lib.org/reference/splice-operator.html" class="external-link">rlang::!!!()</a></code> to expand
|
|
the symbol list as individual arguments. For example,
|
|
<code>dplyr::select(mtcars, !!!input$variabls)</code> which is
|
|
equivalent to <code>dplyr::select(mtcars, !!input$variabls[[1]], !!input$variabls[[2]], ..., !!input$variabls[[length(input$variabls)]])</code>.</p></li>
|
|
</ul></div>
|
|
<div id="see-also">
|
|
<h2>See also</h2>
|
|
<div class="dont-index"><p><code><a href="updateSelectInput.html">updateSelectInput()</a></code></p>
|
|
<p>Other input elements:
|
|
<code><a href="actionButton.html">actionButton</a>()</code>,
|
|
<code><a href="checkboxGroupInput.html">checkboxGroupInput</a>()</code>,
|
|
<code><a href="checkboxInput.html">checkboxInput</a>()</code>,
|
|
<code><a href="dateInput.html">dateInput</a>()</code>,
|
|
<code><a href="dateRangeInput.html">dateRangeInput</a>()</code>,
|
|
<code><a href="fileInput.html">fileInput</a>()</code>,
|
|
<code><a href="numericInput.html">numericInput</a>()</code>,
|
|
<code><a href="passwordInput.html">passwordInput</a>()</code>,
|
|
<code><a href="radioButtons.html">radioButtons</a>()</code>,
|
|
<code><a href="selectInput.html">selectInput</a>()</code>,
|
|
<code><a href="sliderInput.html">sliderInput</a>()</code>,
|
|
<code><a href="submitButton.html">submitButton</a>()</code>,
|
|
<code><a href="textAreaInput.html">textAreaInput</a>()</code>,
|
|
<code><a href="textInput.html">textInput</a>()</code></p></div>
|
|
</div>
|
|
|
|
<div id="ref-examples">
|
|
<h2>Examples</h2>
|
|
<div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="co">## Only run examples in interactive R sessions</span></span></span>
|
|
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/interactive.html" class="external-link">interactive</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="kw"><a href="https://rdrr.io/r/base/library.html" class="external-link">library</a></span><span class="op">(</span><span class="va"><a href="https://ggplot2.tidyverse.org" class="external-link">ggplot2</a></span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="co"># single selection</span></span></span>
|
|
<span class="r-in"><span><span class="fu"><a href="shinyApp.html">shinyApp</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> ui <span class="op">=</span> <span class="fu"><a href="fluidPage.html">fluidPage</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">varSelectInput</span><span class="op">(</span><span class="st">"variable"</span>, <span class="st">"Variable:"</span>, <span class="va">mtcars</span><span class="op">)</span>,</span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="plotOutput.html">plotOutput</a></span><span class="op">(</span><span class="st">"data"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span>,</span></span>
|
|
<span class="r-in"><span> server <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">input</span>, <span class="va">output</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="va">output</span><span class="op">$</span><span class="va">data</span> <span class="op"><-</span> <span class="fu"><a href="renderPlot.html">renderPlot</a></span><span class="op">(</span><span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/ggplot.html" class="external-link">ggplot</a></span><span class="op">(</span><span class="va">mtcars</span>, <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/aes.html" class="external-link">aes</a></span><span class="op">(</span><span class="op">!</span><span class="op">!</span><span class="va">input</span><span class="op">$</span><span class="va">variable</span><span class="op">)</span><span class="op">)</span> <span class="op">+</span> <span class="fu"><a href="https://ggplot2.tidyverse.org/reference/geom_histogram.html" class="external-link">geom_histogram</a></span><span class="op">(</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">}</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">}</span></span></span>
|
|
<span class="r-in"><span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="co"># multiple selections</span></span></span>
|
|
<span class="r-in"><span><span class="kw">if</span> <span class="op">(</span><span class="cn">FALSE</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span><span class="fu"><a href="shinyApp.html">shinyApp</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> ui <span class="op">=</span> <span class="fu"><a href="fluidPage.html">fluidPage</a></span><span class="op">(</span></span></span>
|
|
<span class="r-in"><span> <span class="fu">varSelectInput</span><span class="op">(</span><span class="st">"variables"</span>, <span class="st">"Variable:"</span>, <span class="va">mtcars</span>, multiple <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span>,</span></span>
|
|
<span class="r-in"><span> <span class="fu"><a href="renderTable.html">tableOutput</a></span><span class="op">(</span><span class="st">"data"</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">)</span>,</span></span>
|
|
<span class="r-in"><span> server <span class="op">=</span> <span class="kw">function</span><span class="op">(</span><span class="va">input</span>, <span class="va">output</span><span class="op">)</span> <span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="va">output</span><span class="op">$</span><span class="va">data</span> <span class="op"><-</span> <span class="fu"><a href="renderTable.html">renderTable</a></span><span class="op">(</span><span class="op">{</span></span></span>
|
|
<span class="r-in"><span> <span class="kw">if</span> <span class="op">(</span><span class="fu"><a href="https://rdrr.io/r/base/length.html" class="external-link">length</a></span><span class="op">(</span><span class="va">input</span><span class="op">$</span><span class="va">variables</span><span class="op">)</span> <span class="op">==</span> <span class="fl">0</span><span class="op">)</span> <span class="kw"><a href="https://rdrr.io/r/base/function.html" class="external-link">return</a></span><span class="op">(</span><span class="va">mtcars</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="va">mtcars</span> <span class="op"><a href="https://magrittr.tidyverse.org/reference/pipe.html" class="external-link">%>%</a></span> <span class="fu">dplyr</span><span class="fu">::</span><span class="fu">select</span><span class="op">(</span><span class="op">!</span><span class="op">!</span><span class="op">!</span><span class="va">input</span><span class="op">$</span><span class="va">variables</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">}</span>, rownames <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span></span></span>
|
|
<span class="r-in"><span> <span class="op">}</span></span></span>
|
|
<span class="r-in"><span><span class="op">)</span><span class="op">}</span></span></span>
|
|
<span class="r-in"><span></span></span>
|
|
<span class="r-in"><span><span class="op">}</span></span></span>
|
|
</code></pre></div>
|
|
</div>
|
|
</div>
|
|
<div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
|
|
<nav id="toc" data-toggle="toc" class="sticky-top"><h2 data-toc-skip>Contents</h2>
|
|
</nav></div>
|
|
</div>
|
|
|
|
|
|
<footer><div class="copyright">
|
|
<p></p><p>Developed by Winston Chang, Joe Cheng, JJ Allaire, Carson Sievert, Barret Schloerke, Yihui Xie, Jeff Allen, Jonathan McPherson, Alan Dipert, Barbara Borges.</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.6.</p>
|
|
</div>
|
|
|
|
</footer></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</body></html>
|
|
|