summary: Object Summaries

In steinbaugh/pointillism: Single-cell RNA-seq toolkit

Object Summaries

Description

summary is a generic function used to produce result summaries of the results of various model fitting functions. The function invokes particular methods which depend on the class of the first argument.

Usage

summary(object, ...)

## S4 method for signature 'SeuratMarkers'
summary(object)

## S4 method for signature 'SeuratMarkersPerCluster'
summary(object)

Arguments

object	Object.
...	Additional arguments.

Value

The form of the value returned by summary depends on the class of its argument. See the documentation of the particular methods for details of what is produced by that method.

The default method returns an object of class c("summaryDefault", "table") which has specialized format and print methods. The factor method returns an integer vector.

The matrix and data frame methods return a matrix of class "table", obtained by applying summary to each column and collating the results.

Note

Updated 2022-06-09.

Examples

data(SeuratMarkersPerCluster, package = "AcidTest")

## SeuratMarkersPerCluster ====
object <- SeuratMarkersPerCluster
class(object)
summary(object)

steinbaugh/pointillism documentation built on Oct. 13, 2023, 10:43 p.m.