File: filter_select.Rd

package info (click to toggle)
r-cran-crosstalk 1.2.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 464 kB
  • sloc: javascript: 1,697; sh: 15; makefile: 7
file content (54 lines) | stat: -rw-r--r-- 1,439 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/controls.R
\name{filter_select}
\alias{filter_select}
\alias{filter_checkbox}
\title{Categorical filter controls}
\usage{
filter_select(id, label, sharedData, group, allLevels = FALSE, multiple = TRUE)

filter_checkbox(
  id,
  label,
  sharedData,
  group,
  allLevels = FALSE,
  inline = FALSE,
  columns = 1
)
}
\arguments{
\item{id}{An HTML element ID; must be unique within the web page}

\item{label}{A human-readable label}

\item{sharedData}{\code{SharedData} object with the data to filter}

\item{group}{A one-sided formula whose values will populate this select box.
Generally this should be a character or factor column; if not, it will be
coerced to character.}

\item{allLevels}{If the vector described by \code{group} is factor-based,
should all the levels be displayed as options, or only ones that are
present in the data?}

\item{multiple}{Can multiple values be selected?}

\item{inline}{If \code{TRUE}, render checkbox options horizontally instead of vertically.}

\item{columns}{Number of columns the options should be arranged into.}
}
\description{
Creates a select box or list of checkboxes, for filtering a
\code{\link{SharedData}} object based on categorical data.
}
\examples{
## Only run examples in interactive R sessions
if (interactive()) {

sd <- SharedData$new(chickwts)
filter_select("feedtype", "Feed type", sd, "feed")

}

}