R/print.inpoComponents.R

In InPosition: Inference Tests for ExPosition

#' Print results from InPosition Components Permutation Test
#' 
#' Print Components permutation test results from the inposition.
#' 
#' 
#' @param x an list that contains items to make into the inpoComponents class.
#' @param \dots inherited/passed arguments for S3 print method(s).
#' @author Derek Beaton and Cherise Chin-Fatt
#' @keywords print
#' @export print.inpoComponents
print.inpoComponents <-
function (x,...) {

  res.inpoComponents <- x
  if (!inherits(res.inpoComponents, "inpoComponents")) stop ("no convenient data")
  cat("**InPosition Components Permutation Test data**\n")
  cat("*Contains the following objects:\n\n")
  res <- array("", c(3, 2), list(1:3, c("name", "description")))
  
  res[1,] <- c("$p.vals","p-values associated to components' permutation tests.")
  res[2,] <- c("$eigs.perm","The distributions of permuted eigenvalues.")
  res[3,] <- c("$eigs","The observed eigenvalues.")  
  
  print(res)

}