R/fmca.print.R

In cfda: Categorical Functional Data Analysis

#' Print a \code{fmca} object
#'
#' @param x \code{fmca} object (see \code{\link{compute_optimal_encoding}} function)
#' @param n maximal number of rows and cols to print
#' @param ... Not used.
#'
#' @return No return value, called for side effects
#'
#' @method print fmca
#'
#' @family encoding functions
#' @export
print.fmca <- function(x, n = 6, ...) {
  checkInteger(n, minValue = 0, paramName = "n")

  cat("$basisobj:\n")
  cat("  Type:", x$basisobj$type, "\n")
  cat("  Range:", x$basisobj$rangeval[1], "to", x$basisobj$rangeval[2], "\n")
  cat("  Number of basis functions:", x$basisobj$nbasis, "\n")
  cat("\n$label:", nrow(x$label), "elements", "\n")
  print(head(x$label$label, n))
  cat("\n$eigenvalues:", length(x$eigenvalues), "elements", "\n")
  print(head(x$eigenvalues, n))
  cat("\n$alpha:", "list of", length(x$alpha), "elements", "\n")
  cat("$alpha[[1]]:", nrow(x$alpha[[1]]), "rows", ncol(x$alpha[[1]]), "columns", "\n")
  print(head(x$alpha[[1]], n))
  cat("\n$pc:", nrow(x$pc), "rows", ncol(x$pc), "columns", "\n")
  print(head(x$pc[, seq_len(min(n, ncol(x$pc)))], n))
  cat("\nOther elements: \"F\", \"G\", \"V\", \"pt\"\n")
}


#' @title Object Summaries
#'
#' @description Summary of a \code{fmca} object
#'
#' @param object \code{fmca} object (see \code{\link{compute_optimal_encoding}} function)
#' @param n maximal number of rows and cols to print
#' @param ... Not used.
#'
#' @return No return value, called for side effects
#'
#' @method summary fmca
#'
#' @family encoding functions
#' @export
summary.fmca <- function(object, n = 6, ...) {
  checkInteger(n, minValue = 1, paramName = "n")

  cat("#### FMCA\n\n")
  cat("## Data \n")
  cat("Number of individuals:", nrow(object$pc), "\n")
  cat("Number of states:", nrow(object$label), "\n")
  cat("Time Range:", object$basisobj$rangeval[1], "to", object$basisobj$rangeval[2], "\n")
  cat("States:  ")
  cat(head(object$label$label, n), "\n")
  cat("\n")
  cat("## Basis \n")
  cat("Type:", object$basisobj$type, "\n")
  cat("Number of basis functions:", object$basisobj$nbasis, "\n")
  cat("\n")
  cat("## Outputs\n")
  cat("Eigenvalues:\n  ")
  cat(head(object$eigenvalues, n), "\n")
  cat("\nExplained variance:\n  ")
  cat(round(head(cumsum(object$eigenvalues) / sum(object$eigenvalues), n), 3), "\n")
  cat("\nOptimal encoding:\n")
  print(head(object$alpha[[1]], n))
  cat("\nPrincipal components:\n")
  print(head(object$pc[, seq_len(min(n, ncol(object$pc)))]))
  cat("\n")
  cat("Total elapsed time:", round(object$runTime, 3), "s\n")
}