createDocument: Auto create R Markdown documents

In elastacloud/automatic-data-explorer: Automatic Data Exploration

Description

Automatically generate data exploration reports using R Markdown templates.

Usage

createDocument(df, target, template, reporttitle, reportauthor, documentname,
  documentwd, writedoc = TRUE)

Arguments

df	Dataframe containing the variables of interest
target	For univariate reporting - the target variable
template	The name of the template document to use. Currently only "univariate" is available
reporttitle	Character giving the report title in the YAML header
reportauthor	Character giving the report author's name in the YAML header
documentname	Character giving the filename of the generated report
documentwd	Character giving the directory to which the report should be written
writedoc	Default writedoc = TRUE will auto generate the final document. Changing to writedoc = FALSE will prevent the input .Rmd from being rendered to the specified input (currently only .html) to allow review

Value

If writedoc = TRUE writes .Rmd file and auto generated document to documentwd. If writedoc = FALSE writes .Rmd file only.

elastacloud/automatic-data-explorer documentation built on May 8, 2019, 9:29 a.m.