Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add annotation mapping for SummarizedExperiment and subclasses #194

Merged
merged 1 commit into from
Aug 25, 2024

Conversation

axelklenk
Copy link
Collaborator

This PR adds annotation mapping for SummarizedExperiment data containers and its subclasses SingleCellExperiment and SpatialExperiment.

This will work if gene sets are stored in a GeneSetCollection with geneIdType set to a valid value e.g. by importing them using GSEABase::getGmt() or GSVA::readGMT(). The container classes above need an geneIdType with an OrgDb as its annotation() set as the annotation element of their metadata, e.g.

metadata(sce)$annotation <- ENSEMBLIdentifier("org.Hs.eg.db")

and any gene set IDs supported by org.Hs.eg.db will be automatically converted to ENSEMBL IDs.

Annotation mapping for Biobase::ExpressionSet containers has been verified to continue working where annotation(ES) is not a geneIdType but only a character containing the name of the annotation database package.

Annotation mapping for simpler container types such as matrix or dgCMatrix or with gene sets stored in lists is not supported.

For performing/testing annotation mapping, it is sufficient to call geneSets(par) on a valid parameter object as described above, without running a complete gene set analysis.

@axelklenk axelklenk self-assigned this Aug 25, 2024
@axelklenk axelklenk merged commit 0e2b69f into devel Aug 25, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

1 participant