writeReport.CorrReport: Writes a rmd file for the report [WIP]

Description Usage Arguments Value Examples

Description

Writes a rmd file for the report [WIP]

Usage

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

Arguments

report

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

sub.dir

[character(1)]
the name of the directory where the data report will be saved

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).

override

[logical(1)]
override controls if the function is allowed to override an existing rmd-file

Value

rmd-file location

Examples

1
2
3
4
  corr.task = makeCorrTask(id = "test", data = cars)
  corr.result = makeCorr(corr.task)
  corr.report = makeReport(corr.result)
  writeReport(corr.report, save.mode = FALSE, override = TRUE)

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