cat_jama: JAMA-style summary for a Categorical Row

View source: R/cat_jama.R

cat_jamaR Documentation

JAMA-style summary for a Categorical Row

Description

Summarizes a categorical 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

cat_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.

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

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

ordering : Sorts the row variable: options are "ascending" or "descending"

sortvar : Column to sort row on. Requires ordering to be ascending or descending. By default, will sort based on overall statistics.

digits : significant digits to use.

Value

A dataframe with summary statistics for a categorical variable.

See Also

Additional prewritten summary functions for categorical data: cat_default, cat_pct, cat_count


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