SingleCellAlleleExperiment

implementation of a single cell allele experiment object

https://github.com/agimkeller/singlecellalleleexperiment

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
    4 of 11 committers (36.4%) from academic institutions
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary

Keywords from Contributors

bioconductor-package genomics single-cell bioconductor core-package u24ca289073 core-services shiny rna-velocity gene
Last synced: 10 months ago · JSON representation

Repository

implementation of a single cell allele experiment object

Basic Info
  • Host: GitHub
  • Owner: AGImkeller
  • License: other
  • Language: R
  • Default Branch: devel
  • Homepage:
  • Size: 34.4 MB
Statistics
  • Stars: 7
  • Watchers: 5
  • Forks: 1
  • Open Issues: 0
  • Releases: 0
Created about 3 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog License

README.md

SingleCellAlleleExperiment

Defines a S4 class that is based on SingleCellExperiment. In addition to the usual gene layer, SingleCellAlleleExperiment can also store data for immune genes such as HLAs, Immunoglobulins and KIRs at the allele level and at the level of functionally similar groups of immune genes.

Installation

SingleCellAlleleExperiment and its data package scaeData are available in Bioconductor and can be installed as follows:

```markdown if (!requireNamespace("BiocManager", quietly=TRUE)) install.packages("BiocManager")

BiocManager::install("scaeData") BiocManager::install("SingleCellAlleleExperiment") ```

Alternatively, they can be installed from GitHub using the devtools package:

```markdown if (!require("devtools", quietly = TRUE)) install.packages("devtools")

devtools::installgithub("AGImkeller/scaeData", buildvignettes = TRUE) devtools::installgithub("AGImkeller/SingleCellAlleleExperiment", buildvignettes = TRUE) ```

Biological background and motivation

Immune molecules such as B and T cell receptors, human leukocyte antigens (HLAs) or killer Ig-like receptors (KIRs) are encoded in the genetically most diverse loci of the human genome. Many of these immune genes are hyperpolymorphic, showing high allelic diversity across human populations. In addition, typical immune molecules are polygenic, which means that multiple functionally similar genes encode the same protein subunit.

However, interactive single-cell methods commonly used to analyze immune cells in large patient cohorts do not consider this. This leads to erroneous quantification of important immune mediators and impaired inter-donor comparability.

Workflow for unraveling the immunogenetic diversity in scData

We have developed a workflow that allows quantification of expression and interactive exploration of donor-specific alleles of different immune genes. The workflow is divided into two software packages and one additional data package:

  1. The scIGD software package consist of a Snakemake workflow designed to automate and streamline the genotyping process for immune genes, focusing on key targets such as HLAs and KIRs, and enabling allele-specific quantification from single-cell RNA-sequencing (scRNA-seq) data using donor-specific references. For detailed information of the performed steps and how to utilize this workflow, please refer to its documentation.

  2. To harness the full analytical potential of the results, we've developed a dedicated R package, SingleCellAlleleExperiment presented in this repository. This package provides a comprehensive multi-layer data structure, enabling the representation of immune genes at specific levels, including alleles, genes, and groups of functionally similar genes and thus, allows data analysis across these immunologically relevant, different layers of annotation.

  3. The scaeData is an R/ExperimentHub data package providing datasets generated and processed by the scIGD software package which can be used to explore the data and potential downstream analysis workflows using the here presented novel SingleCellAlleleExperiment data structure. Refer to scaeData for more information regarding the available datasets and source of raw data.

This workflow is designed to support both 10x and BD Rhapsody data, encompassing amplicon/targeted sequencing as well as whole-transcriptome-based data, providing flexibility to users working with different experimental setups.

scIGD workflow Figure 1: Overview of the scIGD workflow for unraveling immunogenomic diversity in single-cell data, highlighting the integration of the SingleCellAlleleExperiment package for comprehensive data analysis.

The SingleCellAlleleExperiment (SCAE) class

The SingleCellAlleleExperiment (SCAE) class serves as a comprehensive multi-layer data structure, enabling the representation of immune genes at specific levels, including alleles, genes, and groups of functionally similar genes and thus, allows data analysis across these immunologically relevant, different layers of annotation. The implemented data object is derived from the SingleCellExperiment (SCE) class and follows similar conventions, where rows should represent features (genes, transcripts) and columns should represent cells.


Scheme of SingleCellAlleleExperiment object structure with lookup table.

Figure 2: Scheme of SingleCellAlleleExperiment object structure with lookup table.


For the integration of the relevant additional data layers (see Figure 2), the quantification data for alleles, generated by the novel scIGD software package, is aggregated into two additional data layers via an ontology-based design principle using a lookup table during object generation.

For example, the counts of the alleles A*01:01:01:01 and A*02:01:01:01 that are present in the raw input data will be combined into the HLA-A immune gene layer (see Table 1 below). Next, all counts of immune genes corresponding to HLA-class I are combined into the HLA-class I functional class layer. See the structure of the used lookup table below.


Table 1: Scheme of the lookup table used to aggregate allele information into multiple data layers.

| Allele | Gene | Function | | :----------- | :--------- | :---------- | | A*01:01:01 | HLA-A | HLA class I | | A*02:01:01 | HLA-A | HLA class I | | ... | ... | ... | | DRB1*01:01:01| HLA-DRB1 | HLA class II|

The resulting SCAE data object can be used in combination with established single cell analysis packages like scater and scran to perform downstream analysis on immune gene expression, allowing data exploration on functional and allele level. See the vignette for further information and insights on how to perform downstream analysis using exemplary data from the accompanying R/Experimenthub package scaeData.

Interoperability with iSEE

You can explore your SingleCellAlleleExperiment object with iSEE

```markdown library(iSEE)

app <- iSEE(scae) app ```

Interoperability with iSEE Figure 2: Exploring the data saved in an SingleCellAlleleExperiment object with iSEE.

Citation

To be added..

Authors

Owner

  • Login: AGImkeller
  • Kind: user

GitHub Events

Total
  • Watch event: 2
  • Push event: 9
  • Fork event: 1
  • Create event: 1
Last Year
  • Watch event: 2
  • Push event: 9
  • Fork event: 1
  • Create event: 1

Committers

Last synced: 10 months ago

All Time
  • Total Commits: 250
  • Total Committers: 11
  • Avg Commits per committer: 22.727
  • Development Distribution Score (DDS): 0.492
Past Year
  • Commits: 15
  • Committers: 4
  • Avg Commits per committer: 3.75
  • Development Distribution Score (DDS): 0.4
Top Committers
Name Email Commits
jonas-schuck j****k@h****e 127
Federico Marini m****f@u****e 64
Katharina Imkeller a****r@g****m 18
Josch9 1****9@u****m 10
Ahmad Al Ajami a****i@k****e 9
ahmadalajami a****i@m****e 9
Jonas J****k@k****e 4
J Wokaty j****y@u****m 3
A Wokaty a****y@s****u 2
AGImkeller 8****r@u****m 2
J Wokaty j****y@s****u 2
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 10 months ago

All Time
  • Total issues: 0
  • Total pull requests: 10
  • Average time to close issues: N/A
  • Average time to close pull requests: about 5 hours
  • Total issue authors: 0
  • Total pull request authors: 3
  • Average comments per issue: 0
  • Average comments per pull request: 0.5
  • Merged pull requests: 9
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • AGImkeller (6)
  • Jonas-Schuck (4)
  • federicomarini (4)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • bioconductor 3,870 total
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 5
  • Total maintainers: 1
bioconductor.org: SingleCellAlleleExperiment

S4 Class for Single Cell Data with Allele and Functional Levels for Immune Genes

  • Versions: 5
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 3,870 Total
Rankings
Dependent repos count: 0.0%
Average: 15.6%
Dependent packages count: 31.3%
Maintainers (1)
Last synced: 10 months ago

Dependencies

DESCRIPTION cran
  • SingleCellExperiment * depends
  • AnnotationDbi * imports
  • BiocGenerics * imports
  • BiocParallel * imports
  • DelayedArray * imports
  • DropletUtils * imports
  • Matrix * imports
  • MatrixGenerics * imports
  • S4Vectors * imports
  • SummarizedExperiment * imports
  • biomaRt * imports
  • dplyr * imports
  • ggplot2 * imports
  • methods * imports
  • org.Hs.eg.db * imports
  • scuttle * imports
  • stats * imports
  • tibble * imports
  • utils * imports
  • BiocStyle * suggests
  • cowplot * suggests
  • gridExtra * suggests
  • knitr * suggests
  • patchwork * suggests
  • rmarkdown * suggests
  • scater * suggests
  • scran * suggests
  • tidyverse * suggests
  • viridis * suggests
.github/workflows/R-CMD-check.yaml actions
  • actions/cache v1 composite
  • actions/checkout v2 composite
  • actions/upload-artifact master composite
  • grimbough/bioc-actions/build-install-check v1 composite
  • grimbough/bioc-actions/run-BiocCheck v1 composite
  • grimbough/bioc-actions/setup-bioc v1 composite
  • r-lib/actions/setup-pandoc v2 composite