get_gof

A unified approach to extract results from a wide variety of models. For
some models <code>get_gof</code> attaches useful attributes to the output. You
can access this information by calling the <code>attributes</code> function:
<code>attributes(get_estimates(model))</code>

Create beautiful and customizable tables to summarize several
statistical models side-by-side. Draw coefficient plots, multi-level
cross-tabs, dataset summaries, balance tables (a.k.a. "Table 1s"), and
correlation matrices. This package supports dozens of statistical models, and
it can produce tables in HTML, LaTeX, Word, Markdown, PDF, PowerPoint, Excel,
RTF, JPG, or PNG. Tables can easily be embedded in 'Rmarkdown' or 'knitr'
dynamic documents. Details can be found in Arel-Bundock (2022)
<doi:10.18637/jss.v103.i01>.

Vincent Arel-Bundock

modelsummary

Summary Tables and Plots for Statistical Models and Data:
Beautiful, Customizable, and Publication-Ready

Joachim Gassen

Nathan Eastwood

Nick Huntington-Klein

Moritz Schwarz

Benjamin Elbers

Grant McDermott

Lukas Wallrich

get_gof function

<dl><dt>model</dt>
<dd>a single model object</dd>
<dt>gof_function</dt>
<dd>function which accepts a model object in the <code>model</code> argument and returns a 1-row <code>data.frame</code> with one custom goodness-of-fit statistic per column.</dd>
<dt>vcov_type</dt>
<dd>string vcov type to add at the bottom of the table</dd>
<dt>...</dt>
<dd>all other arguments are passed through to three functions. See the documentation of these functions for lists of available arguments.<ul>
<li>parameters::model_parameters extracts parameter estimates. Available arguments depend on model type, but include:<ul>
<li><code>standardize</code>, <code>include_reference</code>, <code>centrality</code>, <code>dispersion</code>, <code>test</code>, <code>ci_method</code>, <code>prior</code>, <code>diagnostic</code>, <code>rope_range</code>, <code>power</code>, <code>cluster</code>, etc.</li>
</ul></li>
<li>performance::model_performance extracts goodness-of-fit statistics. Available arguments depend on model type, but include:<ul>
<li><code>metrics</code>, <code>estimator</code>, etc.</li>
</ul></li>
<li>tinytable::tt, kableExtra::kbl or gt::gt draw tables, depending on the value of the <code>output</code> argument. For example, by default <code>modelsummary</code> creates tables with tinytable::tt, which accepts a <code>width</code> and <code>theme</code> arguments.</li>
</ul></dd></dl>

Arguments

Extract goodness-of-fit statistics a tidy format. — get_gof

<dl>

<dt>model</dt>
<dd>a single model object</dd>


<dt>gof_function</dt>
<dd>function which accepts a model object in the <code>model</code> argument and returns a 1-row <code>data.frame</code> with one custom goodness-of-fit statistic per column.</dd>


<dt>vcov_type</dt>
<dd>string vcov type to add at the bottom of the table</dd>


<dt>...</dt>
<dd>all other arguments are passed through to three functions. See the documentation of these functions for lists of available arguments.<ul>
<li>parameters::model_parameters extracts parameter estimates. Available arguments depend on model type, but include:<ul>
<li><code>standardize</code>, <code>include_reference</code>, <code>centrality</code>, <code>dispersion</code>, <code>test</code>, <code>ci_method</code>, <code>prior</code>, <code>diagnostic</code>, <code>rope_range</code>, <code>power</code>, <code>cluster</code>, etc.</li>
</ul></li>
<li>performance::model_performance extracts goodness-of-fit statistics. Available arguments depend on model type, but include:<ul>
<li><code>metrics</code>, <code>estimator</code>, etc.</li>
</ul></li>
<li>tinytable::tt, kableExtra::kbl or gt::gt draw tables, depending on the value of the <code>output</code> argument. For example, by default <code>modelsummary</code> creates tables with tinytable::tt, which accepts a <code>width</code> and <code>theme</code> arguments.</li>
</ul></dd>

</dl>

get_gof: Extract goodness-of-fit statistics a tidy format.

Description

Usage

Arguments