explainer: Generic explainer

In analyzer: Data Analysis and Automated R Notebook Generation

Description

Generic function for printing the details of data. Based on the data type, this calls the appropriate method.

Usage

explainer(X, xname = NULL, ...)

Arguments

X	a data.frame or a vector
xname	name of the data to be printed. If missing then the name of variable passed as X will be used
...	other parameters required for other methods of explainer To see the parameters for numeric methods, use ?explainer.numeric and similarly for other methods (?explainer.factor etc.)

Details

Current methods for explainer are for data.frame, numeric, integer, character and factor vectors. To get the list of all available methods type the command methods(explainer).

Value

Prints the information on the console. For print information for the individual methods, see their documentation. Returns nothing.

Examples

# for numeric
explainer(mtcars)
explainer(mtcars$mpg) #same as explainer.numeric(mtcars$mpg)
# for factor
explainer(as.factor(mtcars$cyl)) #same as explainer.factor(as.factor(mtcars$cyl))

analyzer documentation built on July 1, 2020, 10:02 p.m.