writeReport.CatSumReport: Writes a rmd file for the Categorical Summary Report [WIP]

Description Usage Arguments Value Examples

Description

Writes a rmd file for the Categorical Summary Report [WIP]

Usage

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

Arguments

report

[CatSumReport 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

rmd-file location

Examples

1
2
3
4
5
6
 data("Arthritis", package = "vcd")
 cat.sum.task = makeCatSumTask(id = "Arthritis.Task", data = Arthritis, target = "Improved")
 cat.sum.result = makeCatSum(cat.sum.task)
 #create the numeric summary report
 cat.sum.report = makeReport(cat.sum.result)
 writeReport(cat.sum.report, save.mode = FALSE, override = TRUE)

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