The FilteredData object contains one or more FilteredDataset objects. While FilteredData manages the entire filter panel, each FilteredDataset is @@ -139,7 +123,7 @@
FilteredData
FilteredDataset
As part of the teal workflow, FilteredData, FilteredDataset, and FilterStates are created instantly when the data is loaded and remain unchanged. One @@ -178,7 +162,7 @@
teal
FilterStates
FilteredData is an object responsible for managing the filter panel. It sits on top of the class structure and handles the shiny modules of the subclasses.
shiny
FilteredDataset is a class that keeps unfiltered data and returns filtered data based on the filter call derived from the contained FilterStates. FilteredDataset class @@ -223,7 +207,7 @@
When the app starts, FilteredDataset initializes one or more FilterStates objects, one for each component of the underlying data set. Every FilterStates object is @@ -278,7 +262,7 @@
FilterState
This class controls a single filter card and returns a condition call that depends on the selection state. A FilterState is initialized each time FilterStates adds a new filter. @@ -356,7 +340,7 @@
FilterStateExpr
Similarly to FilterState, FilterStateExpr controls a single filter card and returns logical expression. However, while FilterState generates the call based on the selection @@ -367,7 +351,7 @@
teal_slice
teal_slice is a simple object for storing filter information. It can be thought of as a quantum of information. A teal_slice object is passed directly to @@ -391,7 +375,7 @@
The diagram above presents the filter panel classes and their responsibilities when composing filter calls. Code is generated by nested execution of get_call methods.
get_call
Calling datasets$get_call(<dataname>) in teal modules executes a chain of calls in all filter panel classes. Consider the following scenario:
datasets$get_call(<dataname>)
mtcars
(gear = 3 or gear = 5) and (disp in [205, 295])
Depending on the data type of the selected variable, different filters are shown, for example date pickers, range sliders, checkbox inputs.
Kaledkowski D, Rucki P, Chlebowski A, Verissimo A, Kirar K, Kosinski M, Bates A, Hallal M, Burkoff N, Nasinski M, Pagacz K, Zhao J (2024). teal.slice: Filter Module for 'teal' Applications. -R package version 0.5.1.9010, +R package version 0.5.1.9012, https://github.com/insightsengineering/teal.slice/, https://insightsengineering.github.io/teal.slice/.
@Manual{, title = {teal.slice: Filter Module for 'teal' Applications}, author = {Dawid Kaledkowski and Pawel Rucki and Aleksander Chlebowski and Andre Verissimo and Kartikeya Kirar and Marcin Kosinski and Andrew Bates and Mahmoud Hallal and Nikolas Burkoff and Maciej Nasinski and Konrad Pagacz and Junlue Zhao}, year = {2024}, - note = {R package version 0.5.1.9010, + note = {R package version 0.5.1.9012, https://github.com/insightsengineering/teal.slice/}, url = {https://insightsengineering.github.io/teal.slice/}, }
ui_add
srv_add
ui_active
srv_active
Show R Code
R/utils.R
check_simple_name.Rd
Variable names containing spaces are problematic and must be wrapped in backticks. -Also, they should not start with a number as R may silently make it valid by changing it. -Therefore, we only allow alphanumeric characters with underscores. -The first character of the name must be an alphabetic character and can be followed by alphanumeric characters.
R
name
check_simple_name(name)
(character) vector of names to check
character
Returns NULL or raises error.
NULL
sanitize_id.Rd
Replaces non-ASCII characters into a format that can be used in HTML, +JavaScript and Shiny.
When the id has a character that is not allowed, it is replaced with "_" +and a 4 character hash of the original id is added to the start of the +resulting id.
"_"
sanitize_id(id)
(character(1)) The id string.
character(1)
Sanitized string that removes special characters and spaces.
