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

## ----install, eval=FALSE------------------------------------------------------
# # Development version until the package is on CRAN
# remotes::install_github("ThinkDenominator/gtstats")
# library(gtstats)
# data("birthwt", package = "gtstats")

## ----first-look---------------------------------------------------------------
overview <- describe_data(birthwt)
to_flextable(overview)
overview$issues

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

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

## ----table-one----------------------------------------------------------------
table_one <- summary_table(
  birthwt,
  by = low,
  include = c(age, lwt, race, smoke),
  overall = "last"
) |>
  add_p()

to_flextable(table_one)

## ----optional-rows------------------------------------------------------------
table_one |>
  add_proportion(var = smoke, level = "Yes", label = "Smoking prevalence", ci = TRUE) |>
  add_total() |>
  to_flextable()

## ----compare------------------------------------------------------------------
comparison <- compare_groups(birthwt, variable = lwt, group = low)
to_flextable(comparison)

## ----audit--------------------------------------------------------------------
assumptions_stats(comparison)
diagnostics_stats(comparison)
denominators_stats(comparison)

## ----export, eval=FALSE-------------------------------------------------------
# table_one |>
#   customise_table(
#     title = "Table 1. Vehicle characteristics",
#     theme = "journal"
#   ) |>
#   save_output("table-1.docx", path = tempdir())