writeReport.MDSAnalysisReport: Writes a rmd file for the Multidimensional Scaling Report...

Description Usage Arguments Value Examples

Description

Writes a rmd file for the Multidimensional Scaling Report [WIP]

Usage

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

Arguments

report

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

override

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

Value

Invisible NULL

Examples

1
2
3
4
5
 mds.task = makeMDSTask(id = "swiss", data = swiss)
 mds.analysis.result = makeMDSAnalysis(mds.task)
 mds.analysis.report = makeReport(mds.analysis.result)
 #write the report
 writeReport(mds.analysis.report, save.mode = FALSE, override = TRUE)

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