writeReport.BasicReport: Writes a rmd file for the Basic Report [WIP]

Description Usage Arguments Value Examples

Description

Writes a rmd file for the Basic Report [WIP]

Usage

1
2
3
## S3 method for class 'BasicReport'
writeReport(report, sub.dir = "Data_Report",
  save.mode = TRUE, override = FALSE)

Arguments

report

[BasicReport Object]
The report Object which should be converted to an rmd file

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

Value

Invisible NULL

Examples

1
2
3
4
5
6
7
8
9
  data("airquality")
  report.task = makeBasicReportTask(id = "test.report", data = airquality, target = "Wind")
  report.result = makeReport(report.task)
  writeReport(report.result, save.mode = FALSE, override = TRUE)

  data("iris")
  report.task2 = makeBasicReportTask(id = "test.report2", data = iris, target = "Species")
  report.result2 = makeReport(report.task2)
  writeReport(report.result2, save.mode = FALSE, override = TRUE)

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