writeReport.FAReport: Writes a rmd file for the Factor Analysis Report [WIP]

Description Usage Arguments Value Examples

Description

Writes a rmd file for the Factor Analysis Report [WIP]

Usage

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

Arguments

report

[FAReport 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
 6
 7
 8
 9
10
 library(psych)
 data(bfi)
 #take small sample of size 200L:
 bfi_small = bfi[sample(seq_len(nrow(bfi)), size = 200L), ]
 FA.task = makeFATask(id = "bfi", data = bfi_small)
 FA.result = makeFA(FA.task)
 #create the report
 FA.report = makeReport(FA.result)
 #write the report
 writeReport(FA.report, save.mode = FALSE, override = TRUE)

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