describe: This function describes a vector with summary statistics and...

In MathieuMarauri/explorer: Automatic data exploration with creation of markdown report.

Description

This function describes a vector with summary statistics and plots.

Usage

describe(x, na_type = NULL, min_unique = 15, length_out = 15,
  nchar = 20, plot = TRUE)

Arguments

x	a vector
na_type	a character vector of strings that will be interpreted as NA
min_unique	the minimal number of unique values for a numeric vector to be describe as a numeric vector and not as a categorical vector. Defaults to 15.
length_out	number of unique values displayed in the plots and table for categorical vectors. Defaults to 15.
nchar	maximum number of characters displayed in the plots as level values for categorical vectors. See details.
plot	logical, whether to plot the graph. Defaults to TRUE.

Details

Depending on the class of the vector the functions descNumeric(), descCategorical() or descDate() are called. Each one returns one table with general summary statistics such as the length of x, the number of unique values, the number of missing values. If x is categoric then a frequency table is also returned. Different plots are also generated to see. See the description of the differents functions for more information.

MathieuMarauri/explorer documentation built on Jan. 8, 2020, 6:37 p.m.