cat_default: Default summary for a Categorical Row

View source: R/cat_default.R

cat_defaultR Documentation

Default summary for a Categorical Row

Description

Summarizes a categorical row using counts and column proportions.

Usage

cat_default(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_pct, cat_count, cat_jama


thomasgstewart/tangram.pipe documentation built on June 12, 2022, 1:05 p.m.