summary: Summary Method for 'AnyHermesData' Objects

In insightsengineering/hermes: Preprocessing, analyzing, and reporting of RNA-seq data

Summary Method for AnyHermesData Objects

Description

Provides a concise summary of the content of AnyHermesData objects.

Usage

summary(object, ...)

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

## S4 method for signature 'HermesDataSummary'
show(object)

Arguments

object	(HermesDataSummary) result from the summary method applied to AnyHermesData object.
...	not used.

Value

An object of the corresponding summary class, here HermesDataSummary.

Methods (by class)

• summary(AnyHermesData): A summary method for AnyHermesData object that creates a HermesDataSummary object.

• show(HermesDataSummary): A show method prints summary description of HermesDataSummary object generated by the summary() method.

Examples

object <- hermes_data
object_summary <- summary(object)

# We can access parts of this S4 object with the `slot` function.
str(object_summary)
slotNames(object_summary)
slot(object_summary, "lib_sizes")

# Just calling the summary method like this will use the `show()` method.
summary(object)

insightsengineering/hermes documentation built on Dec. 15, 2024, 8:07 a.m.