https://github.com/carmonalab/tcranker
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 1 DOI reference(s) in README -
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.0%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: carmonalab
- License: gpl-3.0
- Language: R
- Default Branch: master
- Size: 786 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Ranking TCRs to predict tumor-reactivity by paired scRNA and scTCR data
TCRanker is a tool to prioritize the TCRs that are more likely to be tumor-reactive.
It takes as input scRNA-seq data paired with scTCR-seq data, filters cell type wanted (CD8+ T cells by default), and ranks TCRs in a tumor sample according to their likelihood to recognize tumor antigens. To rank TCRs, TCRanker evaluates T cell clonal expansion and T cell transcriptional features associated with tumor reactivity, including exhaustion and proliferation level, in each T cell clonotype.
TCRanker workflow
Installation
TCRanker has dependency on:
To install TCRanker, run:
if (!require("BiocManager", quietly = TRUE))
install.packages("BiocManager")
remotes::install_github("carmonalab/scGate")
remotes::install_github("carmonalab/TCRanker")
Data preparation
Currently, TCRanker supports both Seurat and SingleCellExperiment object as the input query. Optimally, the TCR data should be stored in the query as a column of metadata.
If you want to know how to prepare the data set as input query, we provide you an demonstration of how to prepare a basic Seurat object containing expression matrix together with TCR meta data here
TCRanker
The function has following parameters:
TCRanker(
query,
tcr,
signature = "default",
assay = NULL,
group = "none",
exhaustion = TRUE,
proliferation = TRUE,
species = "auto",
FUN = "mean",
minClonSize = 5,
filterCell = "CD8T",
strictFilter = TRUE,
keepObject = FALSE,
...
)
Only query and tcr are indispensable.
Your could refer TCRanker.demo for more detailed illustration of parameters.
Output
The default output would be a data frame with following structure:
| clonotype | size | freq | exhaustion.score | exhaustion.ranking | proliferation.score | proliferation.ranking | |:---------:|:----:|:----:|:----------------:|:------------------:|:-------------------:|:---------------------:| | ... | ... | ... | ... | ... | ... | ... |
If group was provided, it'd be the column right after clonotype
If custom gene signature(s) were provided, there would be 2 extra columns for each signature. They would be named "SignatureName.score" and "SignatureName.ranking" and positioned prior to the exhaustion and proliferation columns.
Sequential analysis
In order to conduct further in vitro validation or upon the ranking result, you might need to assemble the full nucleotide sequence based on the output. You can check here to see how to use stitchr (Heather et al., (2022)) as an example.
Owner
- Name: Cancer Systems Immunology Lab
- Login: carmonalab
- Kind: organization
- Location: Lausanne, Switzerland
- Website: https://agora-cancer.ch/laboratory/carmona-lab
- Twitter: carmonation
- Repositories: 16
- Profile: https://github.com/carmonalab
At Ludwig Cancer Research Lausanne and Department of Oncology, University of Lausanne & Swiss Institute of Bioinformatics
GitHub Events
Total
Last Year
Dependencies
- R >= 4.2.0 depends
- Seurat * imports
- SeuratObject * imports
- SingleCellExperiment * imports
- SummarizedExperiment * imports
- UCell * imports
- methods * imports
- BiocStyle * suggests
- DT * suggests
- GEOquery * suggests
- knitr * suggests
- rmarkdown * suggests
- scRepertoire * suggests