desc_report: This function renders the univariate exploratory analysis...

Description Usage Arguments

View source: R/desc_report.R

Description

This function renders the univariate exploratory analysis rmardown document with specific parameters.

Usage

1
2
desc_report(data, min_unique = 15, length_out = 15, nchar = 20,
  output_dir = ".", output_file = NULL)

Arguments

data

the dataset to analyse

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.

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 'desc_report'.


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