janitor (version 0.2.1)

adorn_crosstab: Add formatting to a crosstabulation table.

Description

Designed to run on the output of a call to crosstab, this adds formatting, percentage sign, Ns, totals row/column, and custom rounding to a table of numeric values. The result is no longer clean data, but it saves time in reporting table results.

Usage

adorn_crosstab(crosstab, denom = "row", show_n = TRUE, digits = 1, show_totals = FALSE, rounding = "half to even")

Arguments

crosstab

a data.frame with row names in the first column and numeric values in all other columns. Usually the piped-in result of a call to crosstab that included the argument percent = "none".

denom

the denominator to use for calculating percentages. One of "row", "col", or "all".

show_n

should counts be displayed alongside the percentages?

digits

how many digits should be displayed after the decimal point?

show_totals

display a totals summary? Will be a row, column, or both depending on the value of denom.

rounding

method to use for truncating percentages - either "half to even", the base R default method, or "half up", where 14.5 rounds up to 15.

Value

Returns a data.frame.

Examples

library(dplyr) # for the %>% pipe
mtcars %>%
 crosstab(gear, cyl) %>%
 adorn_crosstab(denom = "all")
 
# showing with all parameters
mtcars %>%
 crosstab(gear, cyl) %>%
 adorn_crosstab(., denom = "col", rounding = "half up", show_n = FALSE, digits = 2)
mtcars %>%
 crosstab(cyl, am) %>%
 adorn_crosstab(., denom = "all", digits = 0, rounding = "half up")