audit_vector: This function describes a vector with summary statistics and...
In MathieuMarauri/auditdata: Performs a Quality Audit of a Table

This function describes a vector with summary statistics and plots.

audit_vector(
  x,
  na_type = NULL,
  numeric_cutoff = -1,
  max_length = 15,
  nchar = 20,
  plot = TRUE
)

`x`	a vector
`na_type`	a character vector of strings that will be interpreted as NA
`numeric_cutoff`	the minimum number of distinct values required for a numeric vector not to be coerced to a fator. -1 is the default, meaning no minimum required.
`max_length`	the maximum number of different values to display in the freqeuncy table and the frequency plot, default 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.

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/auditdata documentation built on March 6, 2020, 7:09 p.m.