R/methods-tpm.R

In roryk/bcbioRnaseq: RNA-Seq Utilities

#' Transcripts Per Million (TPM)
#'
#' @name tpm
#' @family Data Functions
#' @author Michael Steinbaugh
#'
#' @inheritParams general
#'
#' @return `matrix`.
#'
#' @examples
#' tpm(bcb_small) %>% glimpse()
NULL



# Methods ======================================================================
#' @rdname tpm
#' @export
setMethod(
    "tpm",
    signature("bcbioRNASeq"),
    function(object) {
        validObject(object)
        data <- assays(object)[["tpm"]]
        assert_is_matrix(data)
        data
    }
)