R/AllMethods.R

In CytoTree: A Toolkit for Flow And Mass Cytometry Data

#' CYT show method
#'
#' Prevents R from crashing by trying to print all slots of an CYT object  if a returned object is not stored in a variable.
#'
#' @param object A CYT object
#' @aliases show, show-method
#'
#' @export
#'
#' @docType methods
#' @method CytoTree show
#'
#' @keywords internal
#'
#' @return Cell number of CYT object
#'
#' @examples
#' 
#' cyt.file <- system.file("extdata/cyt.rds", package = "CytoTree")
#' cyt <- readRDS(file = cyt.file)
#' cyt
#' 
#'
setMethod(
  f = "show",
  signature = "CYT",
  definition = function(object) {
    cat(
      "CYT Information:\n",
      "Input cell number:", nrow(object@raw.data), " cells \n",
      "Enroll marker number:", length(object@markers), " markers \n",
      "Cells after downsampling:", sum(object@meta.data$dowsample), " cells \n"
    )
    invisible(NULL)
  }
)