Skip to contents

Return a plain-language checklist of items to confirm before reporting a result. Use view = "audit" to retrieve the underlying technical status and result codes retained by the analysis object.

Usage

assumptions_stats(
  x,
  format = c("table", "tibble"),
  title = "Checks before reporting",
  subtitle = NULL,
  view = c("checklist", "audit")
)

Arguments

x

A gtstats result.

format

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

title, subtitle

Optional table heading used for format = "table".

view

Either "checklist" (the default, plain-language view) or "audit" (technical status and result codes).

Value

A tibble or gt_tbl.

Examples

result <- compare_groups(mtcars, variable = mpg, group = am)
assumptions_stats(result)
Checks before reporting
Variable Check before reporting Action Details
mpg Independent observations Confirm from study design Confirm from the study design that each observation contributes independently.
mpg Distribution and influential outliers Review alongside automatic check Inspect group distributions or model residuals for influential outliers and severe asymmetry.
assumptions_stats(result, format = "tibble") #> # A tibble: 2 × 4 #> Variable `Check before reporting` Action Details #> <chr> <chr> <chr> <chr> #> 1 mpg Independent observations Confirm from study des… Confir… #> 2 mpg Distribution and influential outliers Review alongside autom… Inspec…