inline_text.tbl_summary: Report statistics from summary tables inline

Description Usage Arguments Value Author(s) See Also Examples

View source: R/inline_text.R

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
## S3 method for class 'tbl_summary'
inline_text(
  x,
  variable,
  column = NULL,
  level = NULL,
  pattern = NULL,
  pvalue_fun = NULL,
  ...
)

## S3 method for class 'tbl_svysummary'
inline_text(
  x,
  variable,
  column = NULL,
  level = NULL,
  pattern = NULL,
  pvalue_fun = NULL,
  ...
)

Arguments

x

Object created from tbl_summary

variable

Variable name of statistic to present

column

Column name to return from x$table_body. Can also pass the level of a by variable.

level

Level of the variable to display for categorical variables. Can also specify the 'Unknown' row. Default is NULL

pattern

String indicating the statistics to return. Uses glue::glue formatting. Default is pattern shown in tbl_summary() output

pvalue_fun

Function to round and format p-values. Default is style_pvalue. The function must have a numeric vector input (the numeric, exact p-value), and return a string that is the rounded/formatted p-value (e.g. pvalue_fun = function(x) style_pvalue(x, digits = 2) or equivalently, purrr::partial(style_pvalue, digits = 2)).

...

Not used

Value

A string reporting results from a gtsummary table

Author(s)

Daniel D. Sjoberg

See Also

Other tbl_summary tools: add_n.tbl_summary(), add_overall(), add_p.tbl_summary(), add_q(), add_stat_label(), bold_italicize_labels_levels, inline_text.tbl_survfit(), modify, tbl_merge(), tbl_stack(), tbl_summary()

Examples

1
2
3
4
t1 <- trial[c("trt", "grade")] %>% tbl_summary(by = trt) %>% add_p()

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

ddsjoberg/gtsummary documentation built on April 8, 2021, 5:48 a.m.