add_ar

This function wraps <code>gtsummary::add_stat()</code> to calculate and display
attack rates (cases per given population multiplier) with 95% confidence
intervals, using the <code>epitabulate::attack_rate()</code> function internally.

Produces tables for descriptive epidemiological analysis.
These tables include attack rates, case fatality ratios, and mortality
rates (with appropriate confidence intervals), with additional
functionality to calculate Mantel-Haenszel odds, risk, and incidence
rate ratios. The methods implemented follow standard epidemiological
approaches described in Rothman et al. (2008, ISBN:978-0-19-513554-2).
This package is part of the 'R4EPIs' project <https://R4EPI.github.io/sitrep/>.

Alexander Spina

epitabulate

Tables for Epidemiological Analysis

Zhian N. Kamvar

Amy Gimma

Kate Doyle

Applied Epi Incorporated 

Medecins Sans Frontieres Operational Centre Amsterdam 

add_ar function

<dl><dt>gts_object</dt>
<dd>A gtsummary object created with functions such as
<code>gtsummary::tbl_summary()</code></dd>
<dt>case_var</dt>
<dd>A logical variable name in the data indicating case status
(e.g. <code>TRUE</code> for cases).</dd>
<dt>population</dt>
<dd>Optional numeric vector giving the population size for
the denominator. If <code>NULL</code>, the population is inferred from the data.</dd>
<dt>multiplier</dt>
<dd>Numeric multiplier used to scale the attack rate
(e.g. <code>1</code> = proportion, <code>100</code> = percent, <code>10^4</code> = per 10,000).</dd>
<dt>drop_tblsummary_stat</dt>
<dd>Logical; if <code>TRUE</code>, removes the original
<code>tbl_summary</code> statistic column (default = <code>FALSE</code>).</dd></dl>

Arguments

Add attack rate statistics to a gtsummary table — add_ar

<dl>

<dt>gts_object</dt>
<dd>A gtsummary object created with functions such as
<code>gtsummary::tbl_summary()</code></dd>


<dt>case_var</dt>
<dd>A logical variable name in the data indicating case status
(e.g. <code>TRUE</code> for cases).</dd>


<dt>population</dt>
<dd>Optional numeric vector giving the population size for
the denominator. If <code>NULL</code>, the population is inferred from the data.</dd>


<dt>multiplier</dt>
<dd>Numeric multiplier used to scale the attack rate
(e.g. <code>1</code> = proportion, <code>100</code> = percent, <code>10^4</code> = per 10,000).</dd>


<dt>drop_tblsummary_stat</dt>
<dd>Logical; if <code>TRUE</code>, removes the original
<code>tbl_summary</code> statistic column (default = <code>FALSE</code>).</dd>

</dl>

add_ar: Add attack rate statistics to a gtsummary table

Description

Usage

Value

Arguments