generate_crosstab: Generate cross-tabulation
In tsg: Generate Publication-Ready Statistical Tables

generate_crosstab

R Documentation

Generate cross-tabulation

Description

Generate cross-tabulation

Usage

generate_crosstab(
  data,
  x,
  ...,
  add_total = TRUE,
  add_total_row = TRUE,
  add_total_column = TRUE,
  add_percent = TRUE,
  as_proportion = FALSE,
  percent_by_column = FALSE,
  name_separator = "_",
  label_separator = "__",
  label_total = "Total",
  label_total_column = NULL,
  label_total_row = NULL,
  label_na = "Not reported",
  include_na = TRUE,
  recode_na = "auto",
  label_as_group_name = TRUE,
  group_separator = " - ",
  group_as_list = FALSE,
  group_grand_total = FALSE,
  group_grand_total_label = "All",
  calculate_per_group = TRUE,
  expand_categories = TRUE,
  position_total = "bottom",
  sort_column_names = TRUE,
  collapse_list = FALSE,
  convert_factor = FALSE,
  metadata = NULL
)

Arguments

`data`	A data frame (typically `tibble`) containing the variables to summarize.
`x`	The variable to use for the rows of the cross-tabulation.
`...`	Additional variable(s) to use for the columns of the cross-tabulation. If none are provided, a frequency table for `x` will be returned.
`add_total`	Logical. If `TRUE`, adds total row and/or column.
`add_total_row`	Logical. If `TRUE`, adds a total row.
`add_total_column`	Logical. If `TRUE`, adds a total column.
`add_percent`	Logical. If `TRUE`, adds percent or proportion values to the table.
`as_proportion`	Logical. If `TRUE`, displays proportions instead of percentages (range 0–1).
`percent_by_column`	Logical. If `TRUE`, percentages are calculated by column; otherwise, by row.
`name_separator`	Character. Separator used when constructing variable names in the output.
`label_separator`	Character. Separator used when constructing labels in the output.
`label_total`	Character. Label used for the total row/category.
`label_total_column`	Character. Label used for the total column/category.
`label_total_row`	Character. Label used for the total row/category.
`label_na`	Character. Label to use for missing (`NA`) values.
`include_na`	Logical. If `TRUE`, includes missing values in the cross table.
`recode_na`	Character or `NULL`. Value used to replace missing values in labelled vectors; `"auto"` will determine a code automatically.
`label_as_group_name`	Logical. If `TRUE`, uses the variable label of the grouping variable(s) as the name in the output list.
`group_separator`	Character. Separator used when constructing group names in the output list.
`group_as_list`	Logical. If `TRUE`, the output will be a list of data frames, one for each combination of grouping variable(s).
`group_grand_total`	Logical. Compute grand total based on the grouping variable.
`group_grand_total_label`	Character. Apply label to the grand total if `group_grand_total` is set to `TRUE`.
`calculate_per_group`	Logical. If `TRUE`, calculates the cross-tabulation separately for each group defined by the grouping variable(s).
`expand_categories`	Logical. If `TRUE`, ensures that all categories of `x` are represented in the output, even if they have zero counts.
`position_total`	Character. Position of the total row/column; either `"bottom"` or `"top"` for rows, and `"right"` or `"left"` for columns.
`sort_column_names`	Logical. If `TRUE`, sorts the column names in the output.
`collapse_list`	Logical (NOT YET IMPLEMENTED). If `TRUE` and `group_as_list = TRUE`, collapses the list of frequency tables into a single data frame with group identifiers. See also `collapse_list()`.
`convert_factor`	Logical. If `TRUE`, converts labelled variables to factors in the output. See also `convert_factor()`.
`metadata`	A named list with optional metadata to attach as attributes, e.g. `title`, `subtitle`, and `source_note`.

Value

A data frame or a list of data frames containing the cross-tabulation results. If group_as_list is TRUE, the output will be a list of data frames, one for each combination of grouping variable(s). Otherwise, a single data frame is returned. Each data frame includes counts and, if specified, percentages or proportions for each combination of x and the additional variables provided in ....

Examples

# Using built-in dataset `person_record`

# Basic usage
person_record |>
 generate_crosstab(marital_status, sex)


# Multiple variables
person_record |>
 generate_crosstab(
  sex,
  seeing,
  hearing,
  walking,
  remembering,
  self_caring,
  communicating
 )

 # Grouping
 person_record |>
   dplyr::group_by(sex) |>
   generate_crosstab(marital_status, employed, group_as_list = TRUE)

# # Percent or proportion by row or column
person_record |>
 generate_crosstab(
   marital_status,
   sex,
   percent_by_column = TRUE
 )

tsg documentation built on Feb. 22, 2026, 5:08 p.m.