R/print.timeBins.r

In Claddis: Measuring Morphological Diversity and Evolutionary Tempo

#' Compact display of time bins
#'
#' @description
#'
#' Displays a compact summary of a timeBins object.
#'
#' @param x An object of class \code{"timeBins"}.
#' @param ... Further arguments passed to or from other methods.
#'
#' @details
#'
#' Displays some basic summary information on a time bins object, including number of bins and their names and timespans.
#'
#' @return
#'
#' Nothing is directly returned, instead a text summary describing a \code{"timeBins"} object is printed to the console.
#'
#' @author Graeme T. Lloyd \email{graemetlloyd@@gmail.com}
#'
#' @examples
#'
#' # Create a time bins object:
#' time_bins <- matrix(
#'   data = c(99.6, 93.5, 93.5, 89.3, 89.3, 85.8, 85.8, 83.5, 83.5, 70.6, 70.6, 65.5),
#'   ncol = 2,
#'   byrow = TRUE,
#'   dimnames = list(
#'     c("Cenomanian", "Turonian", "Coniacian", "Santonian", "Campanian", "Maastrichtian"),
#'     c("fad", "lad")
#'   )
#' )
#'
#' # Set class as timeBins:
#' class(time_bins) <- "timeBins"
#'
#' # Show print.timeBins version of each included data sets:
#' print.timeBins(x = time_bins)
#' @export print.timeBins
print.timeBins <- function(x, ...) {
  
  # Check time_bins has class timeBins and stop and warn user if not:
  if (!inherits(x = x, what = "timeBins")) stop("x must be an object of class \"timeBins\".")
  
  # If not a valid timeBins object then stop and provide feedback to user on what is wrong:
  if (!is.timeBins(x = x)) stop(check_timeBins(time_bins = x)[1])
  
  # Return summary information about object:
  cat(paste0("timeBins object composed of ", nrow(x = x), " bins:"), "\n ", paste0(unname(obj = unlist(x = apply(X = cbind(rownames(x = x), x), MARGIN = 1, FUN = function(y) paste0(y[1], paste0(rep(x = " ", times = max(nchar(x = rownames(x = x))) - nchar(x = y[1]) + 1), collapse = ""), " (", y[2], "-", y[3], " Ma)")))), collapse = "\n  "))
}