binary_jama: JAMA-style summary for a Binary Row

View source: R/binary_jama.R

binary_jamaR Documentation

JAMA-style summary for a Binary Row

Description

Summarizes a binary row using column percentages and the total number in each cell divided by the column total. This is the style used by the Journal of the American Medical Association.

Usage

binary_jama(dt, ...)

Arguments

dt

the name of the dataframe object.

...

Additional arguments supplied within the package row functions.

Details

This is an internal function of tangram.pipe. Additional arguments should be supplied for this function to work properly.

reference : the name of the row category to use as the reference. Default will use alphabetical first category

ref.label : choice of whether you want the reference label to be in the table. Default is on and includes reference label; off switches it off.

rowlabel : the label for the table row name, if different from row_var.

compact : if TRUE, data displayed in one row.

missing : if TRUE, missing data is considered; FALSE only uses complete cases.

digits : significant digits to use.

Value

A dataframe with summary statistics for a binary variable.

See Also

Possible summary functions for binary data:binary_default, binary_pct, binary_count


thomasgstewart/tangram.pipe documentation built on Aug. 18, 2022, 8:41 p.m.