R/print.tydyMutations.R

In MetaEntropy: Functional Shannon Entropy for Virome Mutational Analysis

#' Print method for  \code{tidyMutations} objects
#'
#' This function formats and prints compact mutation summaries
#' (\code{tidyMutations} objects), on the console.
#'
#' @param x An object of class \code{tidyMutations} created by
#'          \code{\link{showMutations}}.
#' @param ... Additional arguments passed to the function.
#'
#' @method print tidyMutations
#' 
#' @return Invisibly returns \code{NULL}. Called for side effect.
#' 
#' @export
#'
print.tidyMutations <- function(x, ...) {
	knitr::kable(x,
		     col.names = c(names(x)[1:2], "abundance (%)"),
		     align = "c") |> cat(sep = "\n")
	invisible(NULL)
}