Methods and accesors for PCAGenomicSignatures object

Source: R/PCAGenomicSignatures-methods.R

The default contents of PCAGenomicSignatures object, with a set of accessor and setter generic functions, which extract either the assay, colData, metadata, or trainingData slots of a PCAGenomicSignatures-class object. When you create this object, colData$studies should be populated before adding any information in trainingData slot

# S4 method for PCAGenomicSignatures
studies(x) <- value

# S4 method for PCAGenomicSignatures
silhouetteWidth(x) <- value

# S4 method for PCAGenomicSignatures
gsea(x) <- value

# S4 method for PCAGenomicSignatures
trainingData(x) <- value

# S4 method for PCAGenomicSignatures
mesh(x) <- value

# S4 method for PCAGenomicSignatures
PCAsummary(x) <- value

# S4 method for PCAGenomicSignatures
studies(x)

# S4 method for PCAGenomicSignatures
silhouetteWidth(x)

# S4 method for PCAGenomicSignatures
gsea(x)

# S4 method for PCAGenomicSignatures
trainingData(x)

# S4 method for PCAGenomicSignatures
mesh(x)

# S4 method for PCAGenomicSignatures
PCAsummary(x)

# S4 method for PCAGenomicSignatures
show(object)

Arguments

value

See details.

object, x

A PCAGenomicSignatures object

Value

PCAGenomicSignatures object with multiple setters or accessors

Details

  • RAVindex(x) : RAVindex (= avgLoadings) containing genes x RAVs

  • metadata(x)$cluster : A vector of integers (from 1:k) indicating the cluster to which each PC is allocated.

  • metadata(x)$size : The number of PCs in each cluster.

  • metadata(x)$k : The number of RAVs.

  • metadata(x)$n : The number of top PCs from each dataset.

  • metadata(x)$geneSets : Name of the prior gene sets used to annotate average loadings.

  • colData(x)$studies : A list of character vectors containing studies contributing to each PC cluster.

  • colData(x)$gsea : A list of data frames. Each element is a subset of outputs from clusterProfiler::GSEA function.

Slots

trainingData

A DataFrame class object for metadata associated with training data

Setters

Setter method values (i.e., function(x) <- value):

  • geneSets<- : A character vector containing the name of gene sets used to annotate average loadings

  • studies<- : A list of character vectors containing gene sets used to annotate average loadings

  • gsea<- : A list of gseaResult objects.

  • metadata<- : A list object of metadata

  • `$<-` : A vector to replace the indicated column in colData

Accessors

All the accessors inherited from SummarizedExperiment are available and the additional accessors for PCAGenomicSignatures specific data are listed below.

  • RAVindex : Equivalent to the assay(x)

  • geneSets : Access the metadata(x)$geneSets slot

  • studies : Access the colData(x)$studies slot

  • gsea : Access the colData(x)$gsea

  • `$` : Access a column in colData

  • trainingData : Access the trainingData slot

  • mesh : Access the trainingData(x)$MeSH slot

  • PCAsummary : Access the trainingData(x)$PCAsummary slot

Examples

data(miniRAVmodel)
miniRAVmodel
#> class: PCAGenomicSignatures 
#> dim: 13934 20 
#> metadata(8): cluster size ... version geneSets
#> assays(1): RAVindex
#> rownames(13934): CASKIN1 DDX3Y ... CTC-457E21.9 AC007966.1
#> rowData names(0):
#> colnames(20): RAV1076 RAV338 ... RAV312 RAV468
#> colData names(4): RAV studies silhouetteWidth gsea
#> trainingData(2): PCAsummary MeSH
#> trainingData names(536): DRP000987 SRP059172 ... SRP164913 SRP188526