R/S3_makeFAReport.R

In ptl93/AEDA: Automated Exploratory Data Analysis

#' Creates an Factor Analysis Report Object
#'
#' @param analysis.obj [\code{FAObj} Object]\cr
#'   A object of the "FAObj" class
#' @return A FAReport Object
#' @import checkmate
#' @import BBmisc
#' @examples
#'  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)
#'  FA.report = makeReport(FA.result)
#' @export
makeReport.FAObj = function(analysis.obj){
  assertClass(analysis.obj, "FAObj")

  #report.id = reportId()
  report.id = deparse(substitute(analysis.obj))

  makeS3Obj("FAReport",
    task = analysis.obj$task,
    fa.result = analysis.obj$fa.result,
    report.id = report.id,
    type = "FAReport")
}

print.FAReport = function(x, ...) {
  print(x$task)
}