R/print.R

In atusy/qntmap: Enhance quantitative analysis of EPMA map

#' `print` method for `qntmap` class object
#'
#' @param x
#'   A `qntmap` class object returned by [`quantify()`] or [`qntmap()`].
#' @param ...
#'   Discarded.
#'
#' @export
print.qntmap <- function(x, ...) {
  message(
    "Summary of",
    paste(dim(x[[c(1L, 1L)]]), collapse = " * "),
    " mass concentration map\n",
    sep = " "
  )
  print(summary(x))
  message(
    "",
    "This is a list object",
    "x$CaO$wt returns CaO mass concentration map, and",
    "x$CaO$se returns CaO standard error map",
    "",
    "The data are also accessible as csv files",
    'in "qntmap" directory below your mapping data directory',
    "e.g., example/.map/1/qntmap/CaO_wt.csv",
    sep = "\n"
  )
  invisible(x)
}