Enable remaining cols_* for gt_group objects

NEWS.md

@@ -16,6 +16,8 @@
 
 * Enable `cols_align()` and `cols_label()` functions for gt_group objects (@shannonhaughton, #2005)
 
+* Enable remaining `cols_*` functions for gt_group objects (@shannonhaughton, #2012)
+
 * `tab_footnote()` + `md()` + docx is now processed correctly (@olivroy, #1892).
 
 # gt 1.0.0

R/cols_add.R

@@ -39,7 +39,7 @@
 #' empty (i.e., all `NA`) columns need to be added, you can use any of the `NA`
 #' types (e.g., `NA`, `NA_character_`, `NA_real_`, etc.) for such columns.
 #'
-#' @inheritParams fmt_number
+#' @inheritParams cols_align
 #'
 #' @param ... *Cell data assignments*
 #'
@@ -226,7 +226,13 @@ cols_add <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = .data)
+  stop_if_not_gt_tbl_or_group(data = .data)
+
+  # Handle gt_group
+  if(inherits(.data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(.data, arg_list))
+  }
 
   # Get the table's boxhead
   boxh_df <- dt_boxhead_get(data = .data)
@@ -404,11 +410,11 @@ cols_add <- function(
       cli::cli_abort("The expression used for `.after` resolved multiple columns.")
     }
   }
-  
+
   if (length(resolved_column_after) == 1 && resolved_column_after == colnames(data_tbl)[NCOL(data_tbl)]) {
     # if requesting the last column to add after, use NULL instead.
     resolved_column_after <- NULL
-  } 
+  }
 
   # Stop function if expressions are given to both `.before` and `.after`
   if (!is.null(resolved_column_before) && !is.null(resolved_column_after)) {
@@ -441,7 +447,7 @@ cols_add <- function(
   } else if (!is.null(resolved_column_before) && is.null(resolved_column_after)) {
 
     before_colnum <- which(colnames(data_tbl) == resolved_column_before)
-    
+
     if (before_colnum <= 1) {
       # put new column first
       updated_data_tbl <-
@@ -480,7 +486,7 @@ cols_add <- function(
       )
 
     after_colnum <- which(boxh_df[["var"]] == resolved_column_after)
-      
+
     updated_boxh_df <-
       vctrs::vec_rbind(
         boxh_df[1:after_colnum, ],

R/cols_align_decimal.R

@@ -33,7 +33,7 @@
 #' number of columns (the function will skip over columns that don't require
 #' this type of alignment).
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param columns *Columns to target*
 #'
@@ -113,7 +113,13 @@ cols_align_decimal <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   # Resolve the `locale` value here with the global locale value
   locale <- resolve_locale(data = data, locale = locale)
@@ -255,3 +261,4 @@ align_to_char <- function(x, align_at = ".") {
 
   x_str
 }
+

R/cols_hide.R

@@ -34,12 +34,7 @@
 #' reference during formatting of other columns) but the final display of those
 #' columns is not necessary.
 #'
-#' @param data *The gt table data object*
-#'
-#'   `obj:<gt_tbl>` // **required**
-#'
-#'   This is the **gt** table object that is commonly created through use of the
-#'   [gt()] function.
+#' @inheritParams cols_align
 #'
 #' @param columns *Columns to target*
 #'
@@ -128,7 +123,13 @@ cols_hide <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   # if no `columns` are provided, return data unaltered
   if (rlang::quo_is_missing(rlang::enquo(columns))) {
@@ -167,7 +168,7 @@ cols_hide <- function(
 #' be important in cases where the user obtains a `gt_tbl` object with hidden
 #' columns and there is motivation to reveal one or more of those.
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param columns *Columns to target*
 #'
@@ -240,7 +241,13 @@ cols_unhide <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   # Get the columns supplied in `columns` as a character vector
   columns <-

R/cols_label.R

@@ -492,7 +492,7 @@ cols_label <- function(
 #' (with `.` representing the vector of column labels), or, an anonymous
 #' function (e.g., `function(x) tools::toTitleCase(x)`).
 #'
-#' @inheritParams fmt_number
+#' @inheritParams cols_align
 #'
 #' @param columns *Columns to target*
 #'
@@ -627,7 +627,13 @@ cols_label_with <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   fn <- rlang::as_function(fn)
 

R/cols_merge.R

@@ -37,7 +37,7 @@
 #' columns (i.e., second and subsequent columns given in `columns`). The
 #' formatting of values in different columns will be preserved upon merging.
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param columns *Columns to target*
 #'
@@ -208,7 +208,13 @@ cols_merge <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   # Get the columns supplied in `columns` as a character vector
   columns <-
@@ -291,7 +297,7 @@ cols_merge <- function(
 #' uncertainties, and any columns specified in `col_uncert` are hidden from
 #' appearing the output table.
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param col_val *Column to target for base values*
 #'
@@ -420,7 +426,13 @@ cols_merge_uncert <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   resolved <-
     cols_merge_resolver(
@@ -478,7 +490,7 @@ cols_merge_uncert <- function(
 #' containing both values separated by an em dash. The column specified in
 #' `col_end` is dropped from the output table.
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param col_begin *Column to target for beginning of range*
 #'
@@ -614,7 +626,13 @@ cols_merge_range <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   resolved <-
     cols_merge_resolver(
@@ -691,7 +709,7 @@ cols_merge_range <- function(
 #' percentages (e.g., `12 (23.2%)`). The column specified in `col_pct` is
 #' dropped from the output table.
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param col_n *Column to target for counts*
 #'
@@ -824,7 +842,13 @@ cols_merge_n_pct <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   resolved <-
     cols_merge_resolver(

R/cols_move.R

@@ -36,7 +36,7 @@
 #' `columns` to be moved is preserved, as is the ordering of all other columns
 #' in the table.
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param columns *Columns to target*
 #'
@@ -110,7 +110,13 @@ cols_move <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   # if no `columns` are provided, return data unaltered
   if (rlang::quo_is_missing(rlang::enquo(columns))) {
@@ -185,7 +191,7 @@ cols_move <- function(
 #' start is preserved (same with the ordering of all other columns in the
 #' table).
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param columns *Columns to target*
 #'
@@ -261,7 +267,13 @@ cols_move_to_start <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   # if no `columns` are provided, return data unaltered
   if (rlang::quo_is_missing(rlang::enquo(columns))) {
@@ -311,7 +323,7 @@ cols_move_to_start <- function(
 #' error prone. The ordering of the `columns` that are moved to the end is
 #' preserved (same with the ordering of all other columns in the table).
 #'
-#' @inheritParams cols_hide
+#' @inheritParams cols_align
 #'
 #' @param columns *Columns to target*
 #'
@@ -387,7 +399,13 @@ cols_move_to_end <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = data)
+  stop_if_not_gt_tbl_or_group(data = data)
+
+  # Handle gt_group
+  if(inherits(data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(data, arg_list))
+  }
 
   # if no `columns` are provided, return data unaltered
   if (rlang::quo_is_missing(rlang::enquo(columns))) {

R/cols_units.R

@@ -40,7 +40,7 @@
 #' pertaining to the units notation can be found in the section entitled
 #' *How to use **gt**'s units notation*.
 #'
-#' @inheritParams fmt_number
+#' @inheritParams cols_align
 #'
 #' @param ... *Column units definitions*
 #'
@@ -272,7 +272,13 @@ cols_units <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = .data)
+  stop_if_not_gt_tbl_or_group(data = .data)
+
+  # Handle gt_group
+  if(inherits(.data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(.data, arg_list))
+  }
 
   # Collect a list of column units
   units_list <- .list

R/cols_width.R

@@ -34,7 +34,7 @@
 #' left-hand side defines the target columns and the right-hand side is a single
 #' dimension.
 #'
-#' @inheritParams fmt_number
+#' @inheritParams cols_align
 #'
 #' @param ... *Column width assignments*
 #'
@@ -112,7 +112,13 @@ cols_width <- function(
 ) {
 
   # Perform input object validation
-  stop_if_not_gt_tbl(data = .data)
+  stop_if_not_gt_tbl_or_group(data = .data)
+
+  # Handle gt_group
+  if(inherits(.data, "gt_group")){
+    arg_list <- as.list(match.call())
+    return(apply_to_grp(.data, arg_list))
+  }
 
   # Collect a named list of column widths
   widths_list <- .list