View source: R/labelselectfield.R
labelselectfield | R Documentation |
labelselectfield
moduleThis module provides an input which allows filtering on the basis of data in
the metadata slot of an ExploratorySummarizedExperiment
. It will only
be called by other modules requiring that input.
labelselectfield(
input,
output,
session,
eselist,
getExperiment = NULL,
labels_from_all_experiments = FALSE,
url_field = "label",
max_items = 1,
field_selection = FALSE,
id_selection = FALSE,
getNonEmptyRows = NULL,
list_input = FALSE
)
input |
Input object |
output |
Output object |
session |
Session object |
eselist |
ExploratorySummarizedExperimentList object containing ExploratorySummarizedExperiment objects |
getExperiment |
Reactive supplying
an |
labels_from_all_experiments |
Derive valid labels from all experiments? |
url_field |
Parameter to extract from the URL to set the value of the select field |
max_items |
Maximum number of metadata values that can be selected |
field_selection |
Allow selection of the meta field to use (TRUE), or use labels (or row ids if the label field is not set)? |
id_selection |
Allow users to pick specific ID from those that relate to the specified label? (default: FALSE) |
getNonEmptyRows |
Optional reactive providing non empty matrix rows |
list_input |
Boolean: will input be a list of values? |
Where metadata is present, the user can select which field to select on, and the value of that field (populated conditionall on field selction). If specified, checkboxes are provided to allow selection of specific row IDs.
A selectizeInput
is used for performance reasons,
providing an autocomplete field for selecting from a list that could stretch
to thousands of entries. This would be difficult to do client-side using a
standard select field.
callModule(labelselectfield, "myid", eselist)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.