R/print.FPCA.R

In fdapace: Functional Data Analysis and Empirical Dynamics

#' Print an FPCA object
#'
#' Print a simple description of an FPCA object
#'
#' @param x An FPCA object.
#' @param ... Not used.
#'
#' @examples
#' \donttest{
#' set.seed(1)
#' n <- 20
#' pts <- seq(0, 1, by=0.05)
#' sampWiener <- Wiener(n, pts)
#' sampWiener <- Sparsify(sampWiener, pts, 10)
#' res <- FPCA(sampWiener$Ly, sampWiener$Lt)
#' res
#' }
#' 
#' @method print FPCA
#' @export
print.FPCA <- function(x, ...){
  obj = x;
  cat(paste0("Functional Principal Components Object for ", tolower(obj$optns$dataType), " data.\n\n"))
  cat(paste0("The optimal number of components selected is: ", length(obj$lambda), ", and \nthe first K (<=3) eigenvalues are: "))
  if ( length(obj$lambda) < 4) { 
    cat(paste0( round(obj$lambda,3) ,"\n"))
  } else {
    cat(paste0( round(obj$lambda[1:3],3) ,"\n"))
  }
}