Rename functions

Author: edelarua

NAMESPACE

@@ -62,7 +62,6 @@ S3method(plot,tbl_regression)
 S3method(plot,tbl_uvregression)
 S3method(print,gtsummary)
 S3method(print,tbl_split)
-S3method(tbl_filter,tbl_hierarchical)
 S3method(tbl_regression,brmsfit)
 S3method(tbl_regression,crr)
 S3method(tbl_regression,default)
@@ -78,7 +77,6 @@ S3method(tbl_regression,multinom)
 S3method(tbl_regression,stanreg)
 S3method(tbl_regression,survreg)
 S3method(tbl_regression,workflow)
-S3method(tbl_sort,tbl_hierarchical)
 S3method(tbl_split,gtsummary)
 S3method(tbl_survfit,data.frame)
 S3method(tbl_survfit,list)
@@ -141,6 +139,7 @@ export(contains)
 export(continuous_summary)
 export(ends_with)
 export(everything)
+export(filter_hierarchical)
 export(filter_p)
 export(gather_ard)
 export(get_gtsummary_theme)
@@ -209,6 +208,7 @@ export(select)
 export(separate_p_footnotes)
 export(set_gtsummary_theme)
 export(show_header_names)
+export(sort_hierarchical)
 export(sort_p)
 export(starts_with)
 export(style_number)
@@ -224,13 +224,11 @@ export(tbl_butcher)
 export(tbl_continuous)
 export(tbl_cross)
 export(tbl_custom_summary)
-export(tbl_filter)
 export(tbl_hierarchical)
 export(tbl_hierarchical_count)
 export(tbl_likert)
 export(tbl_merge)
 export(tbl_regression)
-export(tbl_sort)
 export(tbl_split)
 export(tbl_stack)
 export(tbl_strata)

R/tbl_filter.R renamed to R/filter_hierarchical.R

@@ -11,7 +11,6 @@
 #' @param keep_empty (scalar `logical`)\cr
 #'   Logical argument indicating whether to retain summary rows corresponding to table hierarchy sections that have had
 #'   all rows filtered out. Default is `FALSE`.
-#' @inheritParams rlang::args_dots_empty
 #'
 #' @details
 #' The `filter` argument can be used to filter out rows of a table which do not meet the criteria provided as an
@@ -35,8 +34,9 @@
 #'
 #' @return A `gtsummary` of the same class as `x`.
 #'
-#' @name tbl_filter
-#' @seealso [tbl_sort()]
+#' @seealso [sort_hierarchical()]
+#'
+#' @export
 #'
 #' @examplesIf (identical(Sys.getenv("NOT_CRAN"), "true") || identical(Sys.getenv("IN_PKGDOWN"), "true"))
 #' ADAE_subset <- cards::ADAE |>
@@ -55,26 +55,17 @@
 #'   )
 #'
 #' # Example 1 - Row Sums > 3 -------------------
-#' tbl_filter(tbl, sum(n) > 3)
+#' filter_hierarchical(tbl, sum(n) > 3)
 #'
 #' # Example 2 - Row Sums <= 3 ------------------
-#' tbl_filter(tbl, sum(n) <= 3)
-NULL
+#' filter_hierarchical(tbl, sum(n) <= 3)
+filter_hierarchical <- function(x, filter, keep_empty = FALSE) {
+  set_cli_abort_call()
 
-#' @rdname tbl_filter
-#' @export
-tbl_filter <- function(x, ...) {
+  # check input
   check_not_missing(x)
   check_class(x, "gtsummary")
 
-  UseMethod("tbl_filter")
-}
-
-#' @export
-#' @rdname tbl_filter
-tbl_filter.tbl_hierarchical <- function(x, filter, keep_empty = FALSE, ...) {
-  set_cli_abort_call()
-
   ard_args <- attributes(x$cards$tbl_hierarchical)$args
   x_ard <- x$cards$tbl_hierarchical
 

R/tbl_sort.R renamed to R/sort_hierarchical.R

@@ -21,12 +21,12 @@
 #'     all variables, an error will occur.
 #'
 #'   Defaults to `"descending"`.
-#' @inheritParams rlang::args_dots_empty
 #'
 #' @return A `gtsummary` of the same class as `x`.
 #'
-#' @name tbl_sort
-#' @seealso [tbl_filter()]
+#' @seealso [filter_hierarchical()]
+#'
+#' @export
 #'
 #' @examplesIf (identical(Sys.getenv("NOT_CRAN"), "true") || identical(Sys.getenv("IN_PKGDOWN"), "true"))
 #' theme_gtsummary_compact()
@@ -48,28 +48,19 @@
 #'
 #'
 #' # Example 1 - Descending Frequency Sort ------------------
-#' tbl_sort(tbl)
+#' sort_hierarchical(tbl)
 #'
 #' # Example 2 - Alphanumeric Sort --------------------------
-#' tbl_sort(tbl, sort = "alphanumeric")
+#' sort_hierarchical(tbl, sort = "alphanumeric")
 #'
 #' reset_gtsummary_theme()
-NULL
+sort_hierarchical <- function(x, sort = c("descending", "alphanumeric")) {
+  set_cli_abort_call()
 
-#' @rdname tbl_sort
-#' @export
-tbl_sort <- function(x, ...) {
+  # check input
   check_not_missing(x)
   check_class(x, "gtsummary")
 
-  UseMethod("tbl_sort")
-}
-
-#' @rdname tbl_sort
-#' @export
-tbl_sort.tbl_hierarchical <- function(x, sort = c("descending", "alphanumeric"), ...) {
-  set_cli_abort_call()
-
   sort <- arg_match(sort, error_call = get_cli_abort_call())
   ard_args <- attributes(x$cards$tbl_hierarchical)$args
   x_ard <- x$cards$tbl_hierarchical

man/tbl_filter.Rd renamed to man/filter_hierarchical.Rd

@@ -83,8 +83,8 @@ reference:
   - subtitle: Hierarchical Summary Tables
   - contents:
       - tbl_hierarchical
-      - tbl_sort.tbl_hierarchical
-      - tbl_filter.tbl_hierarchical
+      - sort_hierarchical
+      - filter_hierarchical
       - add_overall.tbl_hierarchical
   - subtitle: Likert Summary Tables
   - contents:

man/tbl_sort.Rd renamed to man/sort_hierarchical.Rd

@@ -1,4 +1,4 @@
-# tbl_filter.tbl_hierarchical() works
+# filter_hierarchical() works
 
     Code
       as.data.frame(tbl)
@@ -17,7 +17,7 @@
       11                                                                  DIARRHOEA               6 (20%)                           3 (7.5%)                          2 (5.9%)
       12                                                                   ERYTHEMA               3 (10%)                            5 (13%)                           6 (18%)
 
-# tbl_filter.tbl_hierarchical() works with various different filter conditions
+# filter_hierarchical() works with various different filter conditions
 
     Code
       as.data.frame(tbl_f)
@@ -36,19 +36,19 @@
       11                                                                  DIARRHOEA               6 (20%)                           3 (7.5%)                          2 (5.9%)
       12                                                                   ERYTHEMA               3 (10%)                            5 (13%)                           6 (18%)
 
-# tbl_filter.tbl_hierarchical() error messaging works
+# filter_hierarchical() error messaging works
 
     Code
-      tbl_filter(data.frame(), sum(n) > 10)
+      filter_hierarchical(data.frame(), sum(n) > 10)
     Condition
-      Error in `check_class()`:
+      Error in `filter_hierarchical()`:
       ! The `x` argument must be class <gtsummary>, not a data frame.
 
 ---
 
     Code
-      tbl_filter(tbl, 10)
+      filter_hierarchical(tbl, 10)
     Condition
-      Error in `tbl_filter()`:
+      Error in `filter_hierarchical()`:
       ! The `filter` argument must be an expression.
 

pkgdown/_pkgdown.yml

@@ -1,4 +1,4 @@
-# tbl_sort.tbl_hierarchical() works
+# sort_hierarchical() works
 
     Code
       as.data.frame(tbl)
@@ -30,19 +30,19 @@
       24                                           AMERICAN INDIAN OR ALASKA NATIVE               0 (NA%)                           1 (100%)                           0 (NA%)
       25                                                                   ERYTHEMA               0 (NA%)                           1 (100%)                           0 (NA%)
 
-# tbl_sort.tbl_hierarchical() error messaging works
+# sort_hierarchical() error messaging works
 
     Code
-      tbl_sort(data.frame())
+      sort_hierarchical(data.frame())
     Condition
-      Error in `check_class()`:
+      Error in `sort_hierarchical()`:
       ! The `x` argument must be class <gtsummary>, not a data frame.
 
 ---
 
     Code
-      tbl_sort(tbl, "10")
+      sort_hierarchical(tbl, "10")
     Condition
-      Error in `tbl_sort()`:
+      Error in `sort_hierarchical()`:
       ! `sort` must be one of "descending" or "alphanumeric", not "10".