R/CDpcaSummary.R

In luisrei/new-cdpca: Clustering and Disjoint Principal Component Analysis

#' CDpcaSummary
#'
#' Print a variety of useful information regarding a CDpca object.
#'
#' @param obj CDpca object
#'
#' @export

CDpcaSummary <- function(obj) {

  if(length(obj)!=18) stop("Invalid CDpca object.")

  cat("Summary of Cluster and Disjoint Principal Component Analysis:\n")
  print(rbind("Loop:" = obj$loop, "Number of iterations:" = obj$iter,
              "F:" = round(obj$Fobj, 5), "Error:" = round(obj$Enorm, 5),
              "Between cluster deviance (%):" = round(obj$bcdev, 2)))
  print(rbind("Explained variance by CDpca components" = obj$dorder))
  cat("Pseudo Confusion Matrix:\n")
  print(obj$pseudocm)
  invisible(obj)
}  # end CDpcaSummary function