combine_terms

The function combines terms from a regression model, and replaces the terms
with a single row in the output table. The p-value is calculated using
<code><a href="/link/stats%3A%3Aanova()?package=gtsummary&version=1.6.3" data-mini-rdoc="gtsummary::stats::anova()">stats::anova()</a></code>.

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

combine_terms function

<dl><dt>x</dt>
<dd>a <code>tbl_regression</code> object</dd>
<dt>formula_update</dt>
<dd>formula update passed to the <a href="/link/stats%3A%3Aupdate?package=gtsummary&version=1.6.3" data-mini-rdoc="gtsummary::stats::update">stats::update</a>.
This updated formula is used to construct a reduced model, and is
subsequently passed to <code><a href="/link/stats%3A%3Aanova()?package=gtsummary&version=1.6.3" data-mini-rdoc="gtsummary::stats::anova()">stats::anova()</a></code> to calculate the p-value for the
group of removed terms. See the <a href="/link/stats%3A%3Aupdate?package=gtsummary&version=1.6.3" data-mini-rdoc="gtsummary::stats::update">stats::update</a> help file for proper syntax.
function's <code>formula.=</code> argument</dd>
<dt>label</dt>
<dd>Option string argument labeling the combined rows</dd>
<dt>quiet</dt>
<dd>Logical indicating whether to print messages in console. Default is
<code>FALSE</code></dd>
<dt>...</dt>
<dd>Additional arguments passed to <a href="/link/stats%3A%3Aanova?package=gtsummary&version=1.6.3" data-mini-rdoc="gtsummary::stats::anova">stats::anova</a></dd></dl>

Arguments

Example 1
<img src="https://raw.githubusercontent.com/ddsjoberg/gtsummary/main/man-images/combine_terms_ex1.png" alt="image of rendered example table" style="width:45%;">

Example Output

Author

The function combines terms from a regression model, and replaces the terms
with a single row in the output table. The p-value is calculated using
<code><a href='https://rdrr.io/r/stats/anova.html'>stats::anova()</a></code>.

Combine terms in a regression model — combine_terms

<dl>

<dt>x</dt>
<dd>a <code>tbl_regression</code> object</dd>


<dt>formula_update</dt>
<dd>formula update passed to the <a href='https://rdrr.io/r/stats/update.html'>stats::update</a>.
This updated formula is used to construct a reduced model, and is
subsequently passed to <code><a href='https://rdrr.io/r/stats/anova.html'>stats::anova()</a></code> to calculate the p-value for the
group of removed terms. See the <a href='https://rdrr.io/r/stats/update.html'>stats::update</a> help file for proper syntax.
function's <code>formula.=</code> argument</dd>


<dt>label</dt>
<dd>Option string argument labeling the combined rows</dd>


<dt>quiet</dt>
<dd>Logical indicating whether to print messages in console. Default is
<code>FALSE</code></dd>


<dt>...</dt>
<dd>Additional arguments passed to <a href='https://rdrr.io/r/stats/anova.html'>stats::anova</a></dd>

</dl>

Example 1
<img src="https://raw.githubusercontent.com/ddsjoberg/gtsummary/main/man-images/combine_terms_ex1.png" alt="image of rendered example table" style="width:45%;">

combine_terms: Combine terms in a regression model

Description

Usage

Value

Arguments

Example Output

Author

See Also