audit_report_html: This function creates the data quality html file with global...

In MathieuMarauri/auditdata: Performs a Quality Audit of a Table

Description

This function creates the data quality html file with global data quality and optionnaly the univaraite exploratory analysis.

Usage

audit_report_html(
  data,
  output_dir = NULL,
  output_file = NULL,
  na_type = NULL,
  numeric_cutoff = -1,
  na_threshold = c(40, 80),
  max_length = Inf,
  nchar = 20,
  order = FALSE,
  global_only = FALSE
)

Arguments

data	the dataset to analyse
output_dir	the directory to write the output file to, default to the current directory.
output_file	name of the output file. If NULL, the default then it is 'quality_report'.
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.
na_threshold	numeric vector defining the range of values for the percentage of missing values to be colored green, orange and red. Default to green before 40 percent, orange between 40 and 80 and red over 80 percent. If NULL then no colors are applied
max_length	the maximum number of rows in the frequency tables. Default to 15.
nchar	maximum number of characters displayed in the plots as level values for categorical vectors.
order	logical, whether to order the columns and rows to display the missing values next to each other, defautl to FALSE.
global_only	logical, should only the global data quality be rendered?

Examples

data(iris)
audit_report_html(iris, "iris.html", global_only = TRUE)
audit_report_html(iris, "iris.html")

MathieuMarauri/auditdata documentation built on March 6, 2020, 7:09 p.m.