inline_text.tbl_continuous: Report statistics from summary tables inline

In gtsummary: Presentation-Ready Data Summary and Analytic Result Tables

Report statistics from summary tables inline

Description

Extracts and returns statistics from a tbl_continuous() object for inline reporting in an R markdown document. Detailed examples in the inline_text vignette

Usage

## S3 method for class 'tbl_continuous'
inline_text(
  x,
  variable,
  column = NULL,
  level = NULL,
  pattern = NULL,
  pvalue_fun = label_style_pvalue(prepend_p = TRUE),
  ...
)

Arguments

x	(tbl_continuous) Object created from tbl_continuous()
variable	(tidy-select) A single variable name of statistic to present
column	(tidy-select) Column name to return from x$table_body. Can also pass the level of a by variable.
level	(string) Level of the variable to display for categorical variables. Default is NULL
pattern	(string) String indicating the statistics to return. Uses glue::glue() formatting. Default is NULL
pvalue_fun	(function) Function to round and format p-values. Default is label_style_pvalue(). The function must have a numeric vector input, and return a string that is the rounded/formatted p-value (e.g. pvalue_fun = label_style_pvalue(digits = 2)).
...	These dots are for future extensions and must be empty.

Value

A string reporting results from a gtsummary table

Author(s)

Daniel D. Sjoberg

Examples

t1 <- trial |>
  tbl_summary(by = trt, include = grade) |>
  add_p()

inline_text(t1, variable = grade, level = "I", column = "Drug A", pattern = "{n}/{N} ({p}%)")
inline_text(t1, variable = grade, column = "p.value")

gtsummary documentation built on Oct. 5, 2024, 1:06 a.m.