getMatrixNames: Obtain matrix names

getMatrixNamesR Documentation

Obtain matrix names

Description

Retrieves the names of matrices present in the specified or provided assay.

Usage

getMatrixNames(object, ...)

## S4 method for signature 'SPATA2'
getMatrixNames(
  object,
  assay_name = activeAssay(object),
  only_proc = FALSE,
  ...
)

## S4 method for signature 'MolecularAssay'
getMatrixNames(object, only_proc = FALSE, ...)

Arguments

object

An object of class SPATA2 or, in case of S4 generics, objects of classes for which a method has been defined.

...

Used to absorb deprecated arguments or functions.

assay_name

Only relevant if the SPATA2 object contains more than one assay: Denotes the assay of interest and thus the molecular modality to use. Defaults to the active assay as set by activateAssay().

only_proc

Logical. If TRUE, only the names of the processed matrices in slot @mtr_proc are returned.

Value

A character vector containing the names of matrices.

See Also

getMatrix()


theMILOlab/SPATA2 documentation built on Feb. 8, 2025, 11:41 p.m.