add parameter for remove_zero_columns

Author: m7pr

R/tm_t_crosstable.R

@@ -19,6 +19,9 @@
 #' @param show_total (`logical(1)`)
 #' Indicates whether to show total column.
 #' Defaults to `TRUE`.
+#' @param remove_zero_columns (`logical(1)`)
+#' Indicates whether to remove columns that contain only zeros from the output table.
+#' Defaults to `FALSE`.
 #'
 #' @note For more examples, please see the vignette "Using cross table" via
 #' `vignette("using-cross-table", package = "teal.modules.general")`.
@@ -163,6 +166,7 @@ tm_t_crosstable <- function(label = "Cross Table",
                             y,
                             show_percentage = TRUE,
                             show_total = TRUE,
+                            remove_zero_columns = FALSE,
                             pre_output = NULL,
                             post_output = NULL,
                             basic_table_args = teal.widgets::basic_table_args(),
@@ -183,6 +187,7 @@ tm_t_crosstable <- function(label = "Cross Table",
 
   checkmate::assert_flag(show_percentage)
   checkmate::assert_flag(show_total)
+  checkmate::assert_flag(remove_zero_columns)
   checkmate::assert_multi_class(pre_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
   checkmate::assert_multi_class(post_output, c("shiny.tag", "shiny.tag.list", "html"), null.ok = TRUE)
   checkmate::assert_class(basic_table_args, classes = "basic_table_args")
@@ -197,6 +202,7 @@ tm_t_crosstable <- function(label = "Cross Table",
     label = label,
     x = x,
     y = y,
+    remove_zero_columns = remove_zero_columns,
     basic_table_args = basic_table_args,
     decorators = decorators
   )
@@ -215,7 +221,7 @@ tm_t_crosstable <- function(label = "Cross Table",
 }
 
 # UI function for the cross-table module
-ui_t_crosstable <- function(id, x, y, show_percentage, show_total, pre_output, post_output, ...) {
+ui_t_crosstable <- function(id, x, y, show_percentage, show_total, remove_zero_columns, pre_output, post_output, ...) {
   args <- list(...)
   ns <- NS(id)
   is_single_dataset <- teal.transform::is_single_dataset(x, y)
@@ -254,7 +260,7 @@ ui_t_crosstable <- function(id, x, y, show_percentage, show_total, pre_output, p
           title = "Table settings",
           checkboxInput(ns("show_percentage"), "Show column percentage", value = show_percentage),
           checkboxInput(ns("show_total"), "Show total column", value = show_total),
-          checkboxInput(ns("remove_zero_columns"), "Remove zero-only columns", value = FALSE)
+          checkboxInput(ns("remove_zero_columns"), "Remove zero-only columns", value = remove_zero_columns)
         )
       ),
       ui_decorate_teal_data(ns("decorator"), decorators = select_decorators(args$decorators, "table"))
@@ -268,7 +274,7 @@ ui_t_crosstable <- function(id, x, y, show_percentage, show_total, pre_output, p
 }
 
 # Server function for the cross-table module
-srv_t_crosstable <- function(id, data, reporter, filter_panel_api, label, x, y, basic_table_args, decorators) {
+srv_t_crosstable <- function(id, data, reporter, filter_panel_api, label, x, y, remove_zero_columns, basic_table_args, decorators) {
   with_reporter <- !missing(reporter) && inherits(reporter, "Reporter")
   with_filter <- !missing(filter_panel_api) && inherits(filter_panel_api, "FilterPanelAPI")
   checkmate::assert_class(data, "reactive")