Add a by attribute to data_tabulate() objects when by is present

NEWS.md

@@ -4,6 +4,9 @@ CHANGES
 
 * `data_read()` now also reads zip-files from URLs (#682).
 
+* `data_tabluate()` now returns an attribute "by" with the
+  `by` variable name when the `by` parameter is used.
+
 # datawizard 1.3.1
 
 CHANGES

R/data_tabulate.R

@@ -183,6 +183,10 @@ data_tabulate.default <- function(
 
   # we go into another function for crosstables here...
   if (!is.null(by)) {
+    by_name <- tryCatch(
+      insight::safe_deparse(substitute(by)),
+      error = function(e) NULL
+    )
     by <- .validate_by(by, x)
     return(.crosstable(
       x,
@@ -191,6 +195,7 @@ data_tabulate.default <- function(
       remove_na = remove_na,
       proportions = proportions,
       obj_name = obj_name,
+      by_name = by_name,
       group_variable = group_variable
     ))
   }
@@ -322,6 +327,10 @@ data_tabulate.data.frame <- function(
     verbose = verbose
   )
 
+  by_name <- tryCatch(
+    insight::safe_deparse(substitute(by)),
+    error = function(e) NULL
+  )
   # validate "by"
   by <- .validate_by(by, x)
   # validate "weights"
@@ -345,6 +354,7 @@ data_tabulate.data.frame <- function(
     class(out) <- c("datawizard_tables", "list")
   } else {
     class(out) <- c("datawizard_crosstabs", "list")
+    attr(out, "by") <- gsub('\\"', "", by_name, fixed = TRUE)
   }
   attr(out, "collapse") <- isTRUE(collapse)
   attr(out, "is_weighted") <- !is.null(weights)
@@ -383,6 +393,11 @@ data_tabulate.grouped_df <- function(
     verbose = verbose
   )
 
+  by_name <- tryCatch(
+    insight::safe_deparse(substitute(by)),
+    error = function(e) NULL
+  )
+
   x <- as.data.frame(x)
 
   out <- list()
@@ -416,6 +431,7 @@ data_tabulate.grouped_df <- function(
     class(out) <- c("datawizard_tables", "list")
   } else {
     class(out) <- c("datawizard_crosstabs", "list")
+    attr(out, "by") <- gsub('\\"', "", by_name, fixed = TRUE)
   }
   attr(out, "collapse") <- isTRUE(collapse)
   attr(out, "is_weighted") <- !is.null(weights)

R/data_xtabulate.R

@@ -7,6 +7,7 @@
   remove_na = FALSE,
   proportions = NULL,
   obj_name = NULL,
+  by_name = NULL,
   group_variable = NULL
 ) {
   if (!is.null(proportions)) {
@@ -89,6 +90,8 @@
   attr(out, "weights") <- weights
   attr(out, "proportions") <- proportions
   attr(out, "varname") <- obj_name
+  attr(out, "by") <- by_name
+
   attr(out, "grouped_df") <- !is.null(group_variable)
   attr(out, "prop_table") <- .prop_table(out)