Draw a forest-style plot from a fitted gtregression object produced by
functions such as uni_reg(), multi_reg(), cox_reg(), or
surv_reg(). Stratified regression outputs are displayed as one
faceted quick-view plot; use forest_df() and forest_reg() for
publication-style stratified forest tables.
Usage
plot_reg(
tbl,
title = NULL,
caption = NULL,
ref_line = NULL,
order_y = NULL,
log_x = FALSE,
xlim = NULL,
breaks = NULL,
point_color = "#1F77B4",
errorbar_color = "#4C4C4C",
base_size = 14,
show_ref = TRUE,
sig_color = NULL,
sig_errorbar_color = NULL,
alpha = 0.05,
show_adjustment_note = TRUE
)Arguments
- tbl
A fitted
gtregressionobject.- title
Optional plot title.
- caption
Optional plot caption. If
NULL, notes are added automatically for adjustedmulti_reg()objects and displayed reference categories.- ref_line
Optional numeric value for the reference line. Defaults to 0 for linear models and 1 otherwise.
- order_y
Optional character vector specifying exposure order.
- log_x
Logical; if
TRUE, use a log-scaled x-axis for non-linear models.- xlim
Optional numeric vector of length 2 specifying x-axis limits.
- breaks
Optional numeric vector of x-axis tick breaks.
- point_color
Fill color for points.
- errorbar_color
Color for error bars.
- base_size
Base font size.
- show_ref
Logical; if
TRUE, reference rows are shown. IfFALSE, binary exposures are shown as compact rows for the estimated non-reference category; affirmative levels such asYesor1are displayed using the variable name.- sig_color
Optional fill color for significant points.
- sig_errorbar_color
Optional color for significant error bars.
- alpha
Significance level for linear models when
p.valueis available.- show_adjustment_note
Logical; if
TRUE, add a default caption describingadjust_forvariables when available.