R/headtail-methods.R

In acidgenomics/r-acidexperiment: Acid Genomics Summarized Experiment

#' @name headtail
#' @inherit AcidGenerics::headtail
#' @note Updated 2023-09-20.
#'
#' @inheritParams AcidRoxygen::params
#' @param ... Additional arguments.
#'
#' @param n `integer(1)`.
#' Positive integer denoting the number of first and last items to include.
#'
#' @examples
#' data(RangedSummarizedExperiment, package = "AcidTest")
#'
#' ## SummarizedExperiment ====
#' object <- RangedSummarizedExperiment
#' headtail(object)
NULL



## Updated 2023-04-27.
`headtail,DFrame` <- # nolint
    methodFunction(
        f = "headtail",
        signature = "data.frame",
        package = "AcidBase"
    )



## Updated 2023-04-27.
`headtail,GRanges` <- # nolint
    function(x, n) {
        headtail(x = as(x, "data.frame"), n = n)
    }

formals(`headtail,GRanges`) <- # nolint
    formals(`headtail,DFrame`)



## Updated 2020-10-07.
`headtail,Matrix` <- # nolint
    methodFunction(
        f = "headtail",
        signature = "matrix",
        package = "AcidBase"
    )



## Updated 2022-05-20.
`headtail,SE` <- # nolint
    function(x, n) {
        headtail(x = assay(x), n = n)
    }

formals(`headtail,SE`) <- # nolint
    formals(`headtail,DFrame`)



#' @describeIn headtail Same method as `data.frame`.
#' @export
setMethod(
    f = "headtail",
    signature = signature(x = "DFrame"),
    definition = `headtail,DFrame`
)

#' @describeIn headtail Summarize the ranges.
#' @export
setMethod(
    f = "headtail",
    signature = signature(x = "GRanges"),
    definition = `headtail,GRanges`
)

#' @describeIn headtail Same method as `matrix`.
#' @export
setMethod(
    f = "headtail",
    signature = signature(x = "Matrix"),
    definition = `headtail,Matrix`
)

#' @describeIn headtail Summarize the primary `assay`.
#' @export
setMethod(
    f = "headtail",
    signature = signature(x = "SummarizedExperiment"),
    definition = `headtail,SE`
)