writeReport: Writes a rmd file Report [WIP]

In ptl93/AEDA: Automated Exploratory Data Analysis

Description

Writes a rmd file Report [WIP]

Usage

writeReport(report, sub.dir, save.mode, override)

Arguments

report	[Report Object] A report Object
sub.dir	[character(1)] the name of the (relative) sub-directory where the data report will be saved. Default is Data_Report
save.mode	[logical(1)] In Save mode its not possible to use an existing folder. To ensure no data is lost, a new folder will be created (if possible). Default is TRUE
override	[logical(1)] override controls if the function is allowed to override an existing rmd-file
...	[character(1)] for now its not used

Value

Invisible NULL; creates a rmd report file

Examples

  data("airquality")
  report.task = makeBasicReportTask(id = "test.report", data = airquality, target = "Wind")
  basic.report = makeReport(report.task)
  writeReport(basic.report, save.mode = FALSE, override = TRUE)

  corr.report.task = makeCorrTask(id = "corr.report", data = airquality, type = "CorrPlot")
  corr.report.result = makeCorr(corr.report.task)
  corr.report = makeReport(corr.report.result)
  writeReport(corr.report, save.mode = FALSE, override = TRUE)

  # Or put the reports together
  finishReport(basic.report, corr.report, save.mode = FALSE, override = TRUE)

ptl93/AEDA documentation built on May 7, 2019, 3:20 p.m.