codeBookSummary: Summarize crunch variables for codeBooks

In Crunch-io/crunchtabs: Custom Report Generation for Crunch Datasets

Summarize crunch variables for codeBooks

Description

This group of functions creates a summarized data.frame that can be cnoverted into either a kable or manually glued into a latex.

Usage

codeBookSummary(x, meta, ...)

## Default S3 method:
codeBookSummary(x, meta, ...)

## S3 method for class 'factor'
codeBookSummary(x, meta, ...)

## S3 method for class 'CategoricalVariable'
codeBookSummary(x, multiple = FALSE, meta = NULL, ...)

## S3 method for class 'MultipleResponseVariable'
codeBookSummary(x, meta = NULL, ...)

## S3 method for class 'CategoricalArrayVariable'
codeBookSummary(x, meta = NULL, ...)

## S3 method for class 'NumericVariable'
codeBookSummary(x, meta = NULL, ...)

## S3 method for class 'TextVariable'
codeBookSummary(x, meta = NULL, ...)

## S3 method for class 'DatetimeVariable'
codeBookSummary(x, meta = NULL, ...)

Arguments

x	A single variable from a crunch dataset
meta	A list containning question meta data
...	Additional arguments, unused.
multiple	Is this a MultipleResponse or CategoricalArray variable?

Methods (by class)

• codeBookSummary(default): The default, throws out anything that does not match expected crunch variable classes

• codeBookSummary(factor): Prepares a codeBookSummary data.frame for a factor

• codeBookSummary(CategoricalVariable): Prepares a codeBookSummary data.frame for a CategoricalVariable

• codeBookSummary(MultipleResponseVariable): Prepares a codeBookSummary data.frame for a MultipleResponseVariable

• codeBookSummary(CategoricalArrayVariable): Prepares a codeBookSummary data.frame for a CategoricalArrayVariable

• codeBookSummary(NumericVariable): Prepares a codeBookSummary data.frame for a NumericVariable

• codeBookSummary(TextVariable): Prepares a codeBookSummary data.frame for a TextVariable

• codeBookSummary(DatetimeVariable): Prepares a codeBookSummary data.frame for a DatetimeVaraible

Crunch-io/crunchtabs documentation built on Jan. 31, 2023, 12:14 p.m.