sort_hierarchical: Sort Hierarchical Tables

In ddsjoberg/gtsummary: Presentation-Ready Data Summary and Analytic Result Tables

Sort Hierarchical Tables

Description

This function is used to sort hierarchical tables. Options for sorting criteria are:

1. Descending - within each section of the hierarchy table, event rate sums are calculated for each row and rows are sorted in descending order by sum (default).

2. Alphanumeric - rows are ordered alphanumerically (i.e. A to Z) by label text. By default, tbl_hierarchical() sorts tables in alphanumeric order.

Usage

sort_hierarchical(x, ...)

## S3 method for class 'tbl_hierarchical'
sort_hierarchical(x, sort = c("descending", "alphanumeric"), ...)

## S3 method for class 'tbl_hierarchical_count'
sort_hierarchical(x, sort = c("descending", "alphanumeric"), ...)

Arguments

x	(tbl_hierarchical, tbl_hierarchical_count) a hierarchical gtsummary table of class 'tbl_hierarchical' or 'tbl_hierarchical_count'.
...	These dots are for future extensions and must be empty.
sort	(string) type of sorting to perform. Value must be one of: "alphanumeric" - at each hierarchy level of the table, rows are ordered alphanumerically (i.e. A to Z) by label text. "descending" - at each hierarchy level of the table, count sums are calculated for each row and rows are sorted in descending order by sum. If sort = "descending", the n statistic is used to calculate row sums if included in statistic for all variables, otherwise p is used. If neither n nor p are present in x for all variables, an error will occur. Defaults to "descending".

Value

A gtsummary of the same class as x.

See Also

filter_hierarchical()

Examples

theme_gtsummary_compact()
ADAE_subset <- cards::ADAE |>
  dplyr::filter(AEBODSYS %in% c("SKIN AND SUBCUTANEOUS TISSUE DISORDERS",
                                "EAR AND LABYRINTH DISORDERS")) |>
  dplyr::filter(.by = AEBODSYS, dplyr::row_number() < 20)

tbl <-
  tbl_hierarchical(
    data = ADAE_subset,
    variables = c(AEBODSYS, AEDECOD),
    by = TRTA,
    denominator = cards::ADSL |> mutate(TRTA = ARM),
    id = USUBJID,
    overall_row = TRUE
  ) |>
  add_overall()


# Example 1 - Descending Frequency Sort ------------------
sort_hierarchical(tbl)

# Example 2 - Alphanumeric Sort --------------------------
sort_hierarchical(tbl, sort = "alphanumeric")

reset_gtsummary_theme()

ddsjoberg/gtsummary documentation built on June 11, 2025, 10:29 p.m.