187 new filter panel api

NAMESPACE

@@ -1,5 +1,10 @@
 # Generated by roxygen2: do not edit by hand
 
+S3method("[",teal_slices)
+S3method(c,teal_slice)
+S3method(c,teal_slices)
+S3method(format,teal_slice)
+S3method(format,teal_slices)
 S3method(get_supported_filter_varnames,FilteredDataset)
 S3method(get_supported_filter_varnames,MAEFilteredDataset)
 S3method(get_supported_filter_varnames,default)
@@ -20,16 +25,17 @@ S3method(init_filtered_data,TealData)
 S3method(init_filtered_data,default)
 S3method(init_filtered_dataset,MultiAssayExperiment)
 S3method(init_filtered_dataset,data.frame)
-S3method(resolve_state,default)
-S3method(resolve_state,default_filter)
-S3method(resolve_state,list)
+S3method(print,teal_slice)
+S3method(print,teal_slices)
 S3method(variable_types,DFrame)
 S3method(variable_types,DataTable)
 S3method(variable_types,data.frame)
 S3method(variable_types,default)
 S3method(variable_types,matrix)
 export(FilterPanelAPI)
 export(clear_filter_states)
+export(filter_settings)
+export(filter_var)
 export(get_filter_expr)
 export(get_filter_state)
 export(init_filter_states)

R/FilterPanelAPI.R

@@ -21,10 +21,10 @@
 #' isolate(fpa$get_filter_state())
 #'
 #' # set a filter state
-#' isolate(
-#'   set_filter_state(
-#'     fpa,
-#'     list(iris = list(Species = list(selected = "setosa", keep_na = TRUE)))
+#' set_filter_state(
+#'   fpa,
+#'   filter_settings(
+#'     filter_var(dataname = "iris", varname = "Species", selected = "setosa", keep_na = TRUE)
 #'   )
 #' )
 #'
@@ -40,10 +40,12 @@
 FilterPanelAPI <- R6::R6Class( # nolint
   "FilterPanelAPI",
   ## __Public Methods ====
+
   public = list(
     #' @description
     #' Initialize a `FilterPanelAPI` object
     #' @param datasets (`FilteredData`) object.
+    #'
     initialize = function(datasets) {
       checkmate::assert_class(datasets, "FilteredData")
       private$filtered_data <- datasets
@@ -56,16 +58,17 @@ FilterPanelAPI <- R6::R6Class( # nolint
     #' The output list is a compatible input to `set_filter_state`.
     #'
     #' @return `list` with named elements corresponding to `FilteredDataset` objects with active filters.
+    #'
     get_filter_state = function() {
       private$filtered_data$get_filter_state()
     },
 
     #' @description
     #' Sets active filter states.
-    #' @param filter (`named list`)\cr
-    #' nested list of filter selections applied to datasets.
+    #' @param filter (`teal_slices`)
+    #'
+    #' @return `NULL` invisibly
     #'
-    #' @return `NULL`
     set_filter_state = function(filter) {
       if (private$filtered_data$get_filter_panel_active()) {
         private$filtered_data$set_filter_state(filter)
@@ -77,10 +80,13 @@ FilterPanelAPI <- R6::R6Class( # nolint
 
     #' @description
     #' Remove one or more `FilterState` of a `FilteredDataset` in the `FilteredData` object.
-    #' @param filter (`named list`)\cr
-    #'  nested list of filter selections applied to datasets.
     #'
-    #' @return `NULL`
+    #' @param filter (`teal_slices`)\cr
+    #'   specifying `FilterState` objects to remove;
+    #'   `teal_slice`s may contain only `dataname` and `varname`, other elements are ignored
+    #'
+    #' @return `NULL` invisibly
+    #'
     remove_filter_state = function(filter) {
       if (private$filtered_data$get_filter_panel_active()) {
         private$filtered_data$remove_filter_state(filter)
@@ -96,7 +102,7 @@ FilterPanelAPI <- R6::R6Class( # nolint
     #'  datanames to remove their `FilterStates`;
     #'  omit to remove all `FilterStates` in the `FilteredData` object
     #'
-    #' @return `NULL`
+    #' @return `NULL` invisibly
     #'
     clear_filter_states = function(datanames) {
       if (private$filtered_data$get_filter_panel_active()) {
@@ -107,14 +113,16 @@ FilterPanelAPI <- R6::R6Class( # nolint
       }
       invisible(NULL)
     },
+
     #' @description
     #' Toggle the state of the global Filter Panel button by running `javascript` code
     #' to click the toggle button with the `filter_panel_active` id suffix.
     #' The button id is prefixed with the Filter Panel shiny namespace.
     #' This button is observed in `srv_filter_panel` method that executes
     #' `filter_panel_enable()` or `filter_panel_disable()` method depending on the toggle state.
     #'
-    #' @return `NULL`
+    #' @return `NULL` invisibly
+    #'
     filter_panel_toggle = function() {
       shinyjs::runjs(
         sprintf(