inline_text.gtsummary

Report statistics from summary tables inline

Creates presentation-ready tables summarizing data
sets, regression models, and more. The code to create the tables is
concise and highly customizable. Data frames can be summarized with
any function, e.g. mean(), median(), even user-written functions.
Regression models are summarized and include the reference rows for
categorical variables. Common regression models, such as logistic
regression and Cox proportional hazards regression, are automatically
identified and the tables are pre-filled with appropriate column
headers.

Daniel D. Sjoberg

gtsummary

Presentation-Ready Data Summary and Analytic Result Tables

Joseph Larmarange

Michael Curry

Jessica Lavery

Karissa Whiting

Emily C. Zabor

Xing Bai

Esther Drill

Jessica Flynn

Margie Hannum

Stephanie Lobaugh

Shannon Pileggi

Amy Tin

Gustavo Zapata Wainberg

inline_text.gtsummary function

<dl><dt>x</dt>
<dd>gtsummary object</dd>
<dt>variable</dt>
<dd>Variable name of statistic to present</dd>
<dt>level</dt>
<dd>Level of the variable to display for categorical variables.
Default is <code>NULL</code></dd>
<dt>column</dt>
<dd>Column name to return from <code>x$table_body</code>.</dd>
<dt>pattern</dt>
<dd>String indicating the statistics to return.
Uses <a href="https://glue.tidyverse.org/reference/glue.html">glue::glue</a> formatting. Default is <code>NULL</code></dd>
<dt>...</dt>
<dd>Not used</dd></dl>

Arguments

Some gtsummary tables report multiple statistics in a single cell,
e.g. <code>"{mean} ({sd})"</code> in <code>tbl_summary()</code> or <code>tbl_svysummary()</code>.
We often need to report just the mean or the SD, and that can be accomplished
by using both the <code>column=</code> and <code>pattern=</code> arguments. When both of these
arguments are specified, the column argument selects the column to report
statistics from, and the pattern argument specifies which statistics to report,
e.g. <code>inline_text(x, column = "stat_1", pattern = "{mean}")</code> reports just the
mean from a <code>tbl_summary()</code>.

column + pattern

Report statistics from summary tables inline — inline_text.gtsummary

<dl>

<dt>x</dt>
<dd>gtsummary object</dd>


<dt>variable</dt>
<dd>Variable name of statistic to present</dd>


<dt>level</dt>
<dd>Level of the variable to display for categorical variables.
Default is <code>NULL</code></dd>


<dt>column</dt>
<dd>Column name to return from <code>x$table_body</code>.</dd>


<dt>pattern</dt>
<dd>String indicating the statistics to return.
Uses <a href='https://glue.tidyverse.org/reference/glue.html'>glue::glue</a> formatting. Default is <code>NULL</code></dd>


<dt>...</dt>
<dd>Not used</dd>

</dl>

Some gtsummary tables report multiple statistics in a single cell,
e.g. <code>"{mean} ({sd})"</code> in <code>tbl_summary()</code> or <code>tbl_svysummary()</code>.
We often need to report just the mean or the SD, and that can be accomplished
by using both the <code>column=</code> and <code>pattern=</code> arguments. When both of these
arguments are specified, the column argument selects the column to report
statistics from, and the pattern argument specifies which statistics to report,
e.g. <code>inline_text(x, column = "stat_1", pattern = "{mean}")</code> reports just the
mean from a <code>tbl_summary()</code>.

inline_text.gtsummary: Report statistics from summary tables inline

Description

Usage

Arguments

column + pattern