summarytools (version 0.8.0)

descr: Univariate Statistics for Numerical Data

Description

Calculates mean, standard deviation, min, max, median, mad, IQR*, CV, skewness*, SE.skewness*, and kurtosis* on numerical vectors. (*) Not available when using sample weights.

Usage

descr(x, stats = "all", na.rm = TRUE, round.digits = 2,
  transpose = FALSE, style = "simple", plain.ascii = TRUE,
  justify = "right", omit.headings = FALSE, use.labels = FALSE,
  display.labels = TRUE, weights = NA, rescale.weights = FALSE, ...)

Arguments

x

A numerical vector or a data frame.

stats

Which stats to produce. Either “all” (default), or a selection of : “mean”, “sd”, “min”, “med”, “max”, “mad”, “iqr”, “cv”, “skewness”, “se.skewness”, “kurtosis”, “n.valid”, and “pct.valid”.

na.rm

Argument to be passed to statistical functions. Defaults to TRUE.

round.digits

Number of significant digits to display. Defaults to 2.

transpose

Logical. Makes variables appears as columns, and stats as rows. Defaults to FALSE.

style

Style to be used by pander when rendering output tables; One of “simple” (default), “grid”, or “rmarkdown”.

plain.ascii

Logical. pander argument; When TRUE, no markup characters will be used (useful when printing to console). Defaults to TRUE when style is “simple”, and FALSE otherwise.

justify

Alignment of columns; “l” for left, “c” for center, or “r” for right (default). Has no effect on html tables.

omit.headings

Logical. Set to TRUE to omit headings.

use.labels

Logical. Display label instead of variable name when label exists.

display.labels

Logical. Should variable / data frame labels be displayed in the title section? Default is TRUE.

weights

Vector of weights having same length as x. NA (default) indicates that no weights are used.

rescale.weights

Logical. When set to TRUE, the total count will be the same as the unweighted x. FALSE by default.

…

Additional arguments passed to pander.

Value

A matrix object containing the statistics, with extra attributes used by summarytool's print method.

Examples

# NOT RUN {
data(exams)
descr(exams)
descr(exams, transpose=TRUE)
descr(exams, stats = c("mean", "sd"))
data(tobacco)
with(tobacco, by(age, smoker, descr))

# }