VennTable: Format an indicator-based pattern table

In vtree: Display Information About Nested Subsets of a Data Frame

Format an indicator-based pattern table

Description

Given a pattern table produced by vtree for indicator (i.e 0/1) variables, VennTable returns an augmented table. The augmented table includes an extra row with the total for each indicator variable and an extra row with the corresponding percentage (which will not in general add to 100%). Also, optionally, does some additional formatting for pandoc markdown.

Usage

VennTable(x, markdown = FALSE, NAcode = "-", unchecked = c("0", "FALSE",
  "No", "no", "not N/A"), checked = c("1", "TRUE", "Yes", "yes", "N/A"),
  sort = TRUE)

Arguments

x	Required: Pattern table produced by vtree for indicator (i.e 0/1) variables
markdown	Format nicely for markdown (see Details).
NAcode	Code to use to represent NAs in markdown formatting
unchecked	Vector of character strings that represent unchecked values; by default: c("0","FALSE","No","no","not N/A")
checked	Vector of character strings that represent checked values; by default: c("1","TRUE","Yes","yes","N/A")
sort	Sort variables by frequency?

Details

The column totals ignore missing values.

When markdown=TRUE, the row and column headings for percentages are labeled "%", indicator values equal to 1 are replaced by checkmark codes, indicator values equal to 0 are replaced by spaces, and missing indicator values are replaced by dashes. Empty headings are replaced by spaces. Finally the table is transposed.

Value

Returns a character matrix with extra rows containing indicator sums.

Author(s)

Nick Barrowman

Examples

# Generate a pattern table for the indicator variables Ind1 and Ind2
ptab <- vtree(FakeData,"Ind1 Ind2",ptable=TRUE)
# Augment the table
ptab2 <- VennTable(ptab)
# Print the result without quotation marks (which are distracting)
print(ptab2,quote=FALSE)
# Generate a table with pandoc markdown formatting
ptab3 <- VennTable(ptab,markdown=TRUE)

vtree documentation built on Dec. 11, 2022, 1:05 a.m.