FilteredDataset R6 classFilteredDataset is a class which renders/controls FilterStates(s)
Each FilteredDataset contains filter_states field - a list which contains one
(data.frame) or multiple (MultiAssayExperiment) FilterStates objects.
Each FilterStates is responsible for one filter/subset expression applied for specific
components of the dataset.
new()Initializes this FilteredDataset object.
FilteredDataset$new(
dataset,
dataname,
keys = character(0),
label = attr(dataset, "label", exact = TRUE)
)datasetany object
dataname(character(1))
syntactically valid name given to the dataset.
keys(character) optional
vector of primary key column names.
label(character(1))
label to describe the dataset.
Object of class FilteredDataset, invisibly.
format()Returns a formatted string representing this FilteredDataset object.
FilteredDataset$format(show_all = FALSE, trim_lines = TRUE)show_all(logical(1)) passed to format.teal_slice.
trim_lines(logical(1)) passed to format.teal_slice.
The formatted character string.
...additional arguments passed to format.
clear_filter_states()Removes all filter items applied to this dataset.
FilteredDataset$clear_filter_states(force = FALSE)force(logical(1))
flag specifying whether to include anchored filter states.
NULL.
get_call()Gets a filter expression.
This function returns filter calls equivalent to selected items
within each of filter_states. Configuration of the calls is constant and
depends on filter_states type and order which are set during initialization.
FilteredDataset$get_call(sid = "")sid(character)
when specified, the method returns code containing conditions calls of
FilterState objects with sid different to this sid argument.
Either a list of filter calls, or NULL.
get_filter_state()Gets states of all contained FilterState objects.
FilteredDataset$get_filter_state()A teal_slices object.
set_filter_state()Set filter state.
FilteredDataset$set_filter_state(state)state(teal_slices)
Virtual method, returns nothing and raises error.
get_dataname()Gets the name of the dataset.
FilteredDataset$get_dataname()A character string.
get_dataset()Gets the dataset object in this FilteredDataset.
FilteredDataset$get_dataset(filtered = FALSE)filtered(logical(1))
The stored dataset. If data.frame or MultiAssayExperiment,
either raw or as a reactive with current filters applied (depending on filtered).
get_filter_overview()Get filter overview of a dataset.
FilteredDataset$get_filter_overview()Virtual method, returns nothing and raises an error.
get_keys()Gets the key columns for this dataset.
FilteredDataset$get_keys()Character vector of variable names
get_dataset_label()Gets the dataset label.
FilteredDataset$get_dataset_label()Character string.
ui_active()shiny module containing active filters for a dataset, along with a title and a remove button.
FilteredDataset$ui_active(id, allow_add = TRUE)id(character(1))
shiny module instance id.
allow_add(logical(1))
logical flag specifying whether the user will be able to add new filters
shiny.tag
srv_active()Server module for a dataset active filters.
FilteredDataset$srv_active(id)id(character(1))
shiny module instance id.
NULL.
ui_add()UI module to add filter variable for this dataset.
FilteredDataset$ui_add(id)id(character(1))
shiny module instance id.
Virtual method, returns nothing and raises error.
srv_add()Server module to add filter variable for this dataset.
For this class srv_add calls multiple modules
of the same name from FilterStates as MAEFilteredDataset
contains one FilterStates object for colData and one for each experiment.
FilteredDataset$srv_add(id)id(character(1))
shiny module instance id.
NULL.
finalize()Object and dependencies cleanup.
Destroy inputs and observers stored in private$session_bindings
Finalize FilterStates stored in private$filter_states
FilteredDataset$finalize()NULL, invisibly.
clone()The objects of this class are cloneable with this method.
FilteredDataset$clone(deep = FALSE)deepWhether to make a deep clone.