Skip to contents

Describe and Check Data

Create baseline descriptive tables and inspect variable compatibility before modeling.

descriptive_table()
Descriptive Summary Table (no gtsummary) using gt/flextable
dissect()
Dissect a dataset before regression

Regression Tables

Create publication-ready crude, adjusted, and multivariable regression tables.

uni_reg()
Univariate regression
multi_reg()
Multivariable regression
cox_reg()
Cox proportional hazards regression
surv_reg()
Parametric survival regression

Stratified Regression Tables

Repeat univariable or adjusted models within levels of a stratifier.

stratified_uni_reg()
Stratified univariable regression
stratified_multi_reg()
Stratified multivariable regression

Visualise Regression Results

Turn regression and survival outputs into curves, forest plots, and publication-style forest tables.

km_plot()
Kaplan-Meier survival plot
km_risk_table()
Kaplan-Meier risk table
rmst_table()
Restricted mean survival time table
survival_summary()
Kaplan-Meier survival summary table
survival_quantiles()
Kaplan-Meier survival quantile table
survival_prob()
Kaplan-Meier survival probability table
logrank_test()
Log-rank test for Kaplan-Meier survival curves
surv_model_compare()
Compare parametric survival model distributions
plot_surv_fit()
Plot observed and fitted parametric survival curves
surv_predict()
Predict survival probabilities from a parametric survival model
plot_reg()
Plot regression estimates
plot_reg_combine()
Side-by-side forest plots: univariate vs multivariable
forest_df()
Build a compatible data frame for forest plots
forest_reg()
Draw a forest table from regression outputs

Diagnostics and Model Selection

Check convergence, collinearity, model fit, and candidate model paths.

check_convergence()
Check regression model convergence
check_collinearity()
Check collinearity using VIF for fitted models
check_ph()
Check proportional hazards assumption for Cox models
plot_model_fit()
Plot model-fit diagnostics
compare_models()
Compare Prespecified Regression Models
select_models()
Stepwise model selection with fit metrics

Confounding and Interaction

Support interpretation with confounding, interaction, and mediation workflows.

identify_confounder()
Identify confounders and effect modifiers
interaction_models()
Compare Models With and Without an Interaction Term
mediation_analysis()
Causal mediation analysis
plot_mediation()
Plot mediation paths

Modify, Merge, and Export

Polish tables, combine outputs, and save tables, plots, or Word reports.

modify_table()
Modify Regression/Descriptive Tables (labels, headers, caption, notes)
merge_tables()
Merge gtregression tables and preserve structure and notes
save_table()
Save a single regression or summary table
save_docx()
Save multiple tables and plots to a Word document
save_plot()
Save a single plot
save_forest()
Save a forest_reg() output

Object Helpers

Inspect and print objects returned by gtregression functions.

`$`(<gtregression>)
Access fields on gtregression objects with `$`
print(<gtregression>)
Print gtregression objects (unified)

Example Datasets

Built-in datasets for examples, teaching, and tests.

data_birthwt
Birth Weight Data
data_PimaIndiansDiabetes
PimaIndians2 Diabetes Dataset
data_gt_quin
Student Absenteeism in Rural Schools
data_epilepsy
Epilepsy Treatment and Seizure Counts
data_endometrial
Endometrial Cancer Histology Grade Data
data_diabetes_mediation
Diabetes Mediation Teaching Dataset
data_infertility
Infertility Matched Case-Control Study
data_lungcancer
Lung Cancer Trial Data