Add summary statistics to a add_var object

This function generates summary statistics for variables from a data frame that has been processed by add_var(), with options to format outputs.

add_summary(
  data,
  add_overall = TRUE,
  continuous_format = NULL,
  norm_continuous_format = "{mean} ± {SD}",
  unnorm_continuous_format = "{median} ({Q1}, {Q3})",
  categorical_format = "{n} ({pct})",
  binary_show = "last",
  digit = 2
)

Arguments

data

A data frame that has been processed by add_var().

add_overall

Logical indicating whether to include an "Overall" summary column. TRUE, by default.

continuous_format

Format string to override both normal/abnormal continuous formats. Accepted placeholders are {mean}, {SD}, {median}, {Q1}, {Q3}.

norm_continuous_format

Format string for normally distributed continuous variables. Default is "{mean} ± {SD}". Accepted placeholders same as continuous_format.

unnorm_continuous_format

Format string for non-normal continuous variables. Default is "{median} ({Q1}, {Q3})". Accepted placeholders same as continuous_format.

categorical_format

Format string for categorical variables. Default is "{n} ({pct})". Accepted placeholders are {n} and {pct}.

binary_show

Display option for binary variables:

  • "first": show only first level

  • "last": show only last level, default

  • "all": show all levels

digit

digit A numeric determine decimal.

Value

A data frame containing summary statistics with the following columns:

  • variable: Variable name

  • Overall (n=X): Summary statistics for all data, if add_overall=TRUE

  • Group-specific columns named [group] (n=X) with summary statistics

Examples

# `data` is a data frame processed by `add_var()`:
data <- add_var(iris, var = c("Sepal.Length", "Sepal.Width"), group = "Species")
# Add summary statistics
result <- add_summary(data, add_overall = TRUE)
#> ⠙ Summarizing
#> ✔ Summarizing [34ms]
#> 
result <- add_summary(data, continuous_format = "{mean}, ({SD})")
#> ⠙ Summarizing
#> ✔ Summarizing [30ms]
#>