Remove a processed matrix — removeProcessedMatrix • SPATA2

Removes a processed matrix from the SPATA2 object.

removeProcessedMatrix(object, mtr_name, assay_name = activeAssay(object))

Arguments

object: An object of class SPATA2 or, in case of S4 generics, objects of classes for which a method has been defined.
mtr_name: Character value. The name of the matrix of interest. Defaults to the active matrix of the assay, as denoted by activateMatrix().
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().

Value

The updated input object, containing the added, removed or computed results.

Note

If the removed matrix was the active matrix the new active matrix is defined as the last element of getMatrixNames().

Examples

library(SPATA2)

data("example_data")

object <- example_data$object_UKF313T_diet

getMatrixNames(object)
getProcessedMatrixNames(object)

object <- normalizeCounts(object, method = "LogNormalize")

getProcessedMatrixNames(object)

object <- removeProcessedMatrix(object, mtr_name = "LogNormalize")

getProcessedMatrixNames(object)