## ----setup, include=FALSE-----------------------------------------------------
knitr::opts_chunk$set(collapse = TRUE, comment = "#>", eval = TRUE)

## ----prepare------------------------------------------------------------------
library(gtstats)
data("birthwt", package = "gtstats")
birthwt_data <- birthwt

## ----describe-----------------------------------------------------------------
overview <- describe_data(birthwt_data)
to_flextable(overview)
overview$issues

## ----distribution-------------------------------------------------------------
distribution <- assess_distribution(
  birthwt_data,
  vars = c(age, lwt),
  by = low
)
to_flextable(distribution)
distribution$recommendations

## ----variance-----------------------------------------------------------------
variance <- assess_variance(birthwt_data, vars = c(age, lwt), by = low)
to_flextable(variance)

## ----table-one----------------------------------------------------------------
table_one <- summary_table(
  birthwt_data,
  by = low,
  include = c(age, lwt, race, smoke, ht, ui,
              previous_preterm, antenatal_visits),
  overall = "first"
) |>
  add_p()

to_flextable(table_one)

## ----render-export, eval=FALSE------------------------------------------------
# table_one |>
#   customise_table(
#     title = "Participant characteristics by birth-weight outcome",
#     theme = "journal"
#   ) |>
#   save_output("table-1.docx", path = tempdir())

## ----compare------------------------------------------------------------------
weight_comparison <- compare_groups(
  birthwt_data,
  variable = lwt,
  group = low
)
to_flextable(weight_comparison)

# The exact automatic rule and observed inputs are retained for review.
weight_comparison$method$selection_rule
weight_comparison$method$selection_inputs

assumptions_stats(weight_comparison)
diagnostics_stats(weight_comparison)
denominators_stats(weight_comparison)