R/cl-def-TraCoe.R

In vbonhomme/Momocs: Morphometrics using R

#' Traditional morphometrics class
#'
#' Defines the builder for traditional measurement class in Momocs.
#' Is is intended to ease calculations, data handling and multivariate statistics
#' just ad the other Momocs' classes
#' @param coe a matrix of measurements
#' @param fac a data.frame for covariates
#' @return a list of class TraCoe
#' @family classes
#' @examples
#' # let's (more or less) rebuild the flower dataset
#' fl <- TraCoe(iris[, 1:4], dplyr::tibble(sp=iris$Species))
#' fl %>% PCA() %>% plot("sp")
#' @export
TraCoe <- function(coe = matrix(), fac = dplyr::tibble()) {
  structure(
    list(coe = coe, fac = tibble::as_tibble(fac)),
    class=c("TraCoe", "Coe")
  )
}

#' @export
print.TraCoe <- function(x, ...) {
  TraCoe <- x
  ### Header
  cat("A TraCoe object ", rep("-", 20), "\n", sep = "")
  shp.nb <- nrow(TraCoe$coe)
  var.nb <- ncol(TraCoe$coe)
  cat(" - $coe:", shp.nb, "shapes described with", var.nb, "variables\n")
  # we print the fac
  .print_fac(TraCoe$fac)
}