Skip to contents

Return a transparent audit of the observations, missing values, numerators, denominators, and denominator rules used in a gtstats result.

Usage

denominators_stats(
  x,
  format = c("table", "tibble"),
  title = "Denominator audit",
  subtitle = NULL,
  view = c("readable", "audit")
)

Arguments

x

A gtstats result.

format

Output format: "table" (default) or "tibble".

title, subtitle

Optional table heading used for format = "table".

view

Either "readable" (the default, plain-language headings) or "audit" (raw field names retained by the analysis object).

Value

A tibble or gt_tbl.

Examples

result <- proportion_stats(mtcars, var = vs, by = am)
denominators_stats(result)
Denominator audit
Variable Level Group Eligible observations Used in analysis Missing / excluded Numerator Denominator Rule
vs NA am = 1 13 13 0 NA 13 Non-missing observations; event level = 1
vs NA am = 0 19 19 0 NA 19 Non-missing observations; event level = 1