Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 3.53 KB

README.md

File metadata and controls

52 lines (33 loc) · 3.53 KB

scIRcom

A toolkit for single-cell immune profiling

Introduction

Single-cell sequencing is an emerging technology in the field of immunology and oncology that allows researchers to couple RNA quantification and other modalities, like immune cell receptor profiling at the level of an individual cell. A number of workflows and software packages have been created to process and analyze single-cell transcriptomic data. These packages allow users to take the vast dimensionality of the data generated in single-cell-based experiments and distill the data into novel insights. Unlike the transcriptomic field, there is a lack of options for software that allow for single-cell immune receptor profiling. Enabling users to easily combine RNA and immune profiling, scRepertoire was built to process data derived from the 10x Genomics Chromium Immune Profiling for both T-cell receptor (TCR) and immunoglobulin (Ig) enrichment workflows and subsequently interacts with the popular Seurat R package.

Applying Deep Learning to VDJ data

scRepertoire is compatible and integrated with the R packages Trex for deep-learning-based autencoding of the T cell receptor and Ibex for the B cell receptor.

Wrapper Functions

scRepertoire v1.0.2 has the functionality of the powerTCR approach to comparing clone size distribution, please cite the manuscript if using the clonesizeDistribution() function. In addition, we recently added the Startrac clonotype metrics, if using the StartracDiversity() please read and cite the accompanying article.

Installation of Master Branch

devtools::install_github("chinure/scIRcom")

Most up-to-date version

devtools::install_github("chinure/scIRcom@dev")

We are working on constantly improving the scRepertoire package - these improvements can be found under the "refine" branch. These changes will be incorporated into the main branch as they are tested more throughly.

Bioconductor

scRepertoire is now on Bioconductor. Use the link to find out more information. scRepertoire (for R v4 or greater) can be installed from Bioconductor with:

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

BiocManager::install("scRepertoire")

Getting Data

Unfortunately, Github limits the size of individual files. In order to access the seurat object paired with scRepetoire please download the .rda from here.

Learning To Use scRepertoire

Vignette available here, includes almost 13,000 T cells across 3 patients with renal clear cell carcinoma.

Please Cite

Feel free to use, edit, modify scRepertoire, but if you do, please cite the manuscript.

Contact

Questions, comments, suggestions, please feel free to contact Nick Borcherding via this repository, email, or using twitter.