Describe: Summary Description Table

In SciencesPo: A Tool Set for Analyzing Political Behavior Data

Description

Produce summary description table of a dataframe with the following features: variable names, labels, factor levels, frequencies or summary statistics.

Usage

Describe(.data, style = "multiline", justify = "left", max.number = 10,
  trim.strings = FALSE, max.width = 15, digits = 2, split.cells = 35,
  display.labels = FALSE, display.attributes = FALSE, file = NA,
  append = FALSE, escape.pipe = FALSE, ...)

Arguments

.data	a data frame.
style	the style to be used in pander table, one of “multiline”, “grid”, “simple”, and “rmarkdown”.
justify	pander argument; defaults is justified to “left”.
max.number	an integer for the maximum number of items to be displayed in the frequency cell. If variable has more distinct values, no frequency will be shown (only a message stating the number of distinct values).
trim.strings	remove white spaces at the beginning or end of the string. This may impact the frequencies, so interpret the frequencies cell accordingly. Defaults to FALSE.
max.width	Limits the number of characters to display in the frequency tables. Defaults to 15.
digits	the number of digits for rounding.
split.cells	pander argument. Number of characters allowed on a line before splitting the cell. Defaults to 35.
display.labels	If TRUE, variable labels will be displayed. Defaults to FALSE.
display.attributes	If TRUE, variable attibutes will be displayed. Defaults to FALSE.
file	the text file to be written to disk. Defaults to NA.
append	When “file” argument is supplied, this indicates whether to append output to existing file (TRUE) or to overwrite any existing file (FALSE, default). If TRUE and no file exists, a new file will be created.
escape.pipe	Only useful when style='grid' and file argument is not NA, in which case it will escape the pipe character (|) to allow Pandoc to correctly convert multiline cells.
...	additional arguments passed to pander.

Details

The IQR formula used is the R standard IQR(x) = quantile(x, 3/4) - quantile(x, 1/4). The (CV) stands for the coefficient of variation also known as relative standard deviation (RSD), defined as the ratio of the standard deviation to the mean.

Author(s)

Daniel Marcelino, [e-mail]

Examples

data(religiosity)
Describe(religiosity)

SciencesPo documentation built on May 29, 2017, 9:28 p.m.