analyzer (version 1.0.1)

GenerateReport: Generate the report

Description

GenerateReport generates the markdown report in one command

Usage

GenerateReport(
  dtpath,
  catVars,
  yvar = NULL,
  model = "linReg",
  title = "Report",
  output_format = "html_document",
  output_dir = tempdir(),
  normality_test_method = "ks",
  interactive.plots = FALSE,
  include.vars = NULL
)

Arguments

dtpath

dataset path as a string

catVars

vector of categorical variables names

yvar

y variable name if present else NULL

model

type of model - linReg for linear regression binClass for binary classification and multiClass for multiclass classification

title

Title of the generated report

output_format

output report format. 'html_documennt' for html file or pdf_document for pdf file output. OR c("html_document", "pdf_document") for both.

output_dir

Directory where the output files needs to be stored.

normality_test_method

method for normality test for a variable. Values can be shapiro for Shapiro-Wilk test or 'anderson' for 'Anderson-Darling' test of normality or ks for 'Kolmogorov-Smirnov'

interactive.plots

for interactive variable exploration

include.vars

include only these variables from the full data

Value

creates a rmarkdown and html/pdf file. Returns the output directory on successful run and FALSE in case of error

Details

This function creates a rmarkdown report which can be converted to html or pdf format file.

Examples

# NOT RUN {
# Assigning the temporary folder using tempdir(). replace with required directory
GenerateReport(dtpath = mtcars,
               catVars = c("cyl", "vs", "am", "gear"),
               yvar = "vs", model = "binClass",
               output_format = NULL,
               title = "Report",
               output_dir = tempdir(),          # pass the output directory
               interactive.plots = FALSE)       # set TRUE for interactive

# }