Skip to main content

TCRcloud is a TCR repertoire visualization and comparison tool

Project description

License PyPI - Python Version PyPI PyPI - Wheel GitHub last commit

TCRcloud

TCRcloud is a TCR repertoire visualization and comparison tool

Instalation

TCRcloud is written in python and can be installed from PyPI using pip:

$ pip3 install TCRcloud

Currently it is only compatible with linux-64 and osx-64 because one of the dependencies used is also only compatible with those operating systems. It does work on WSL if you want to use Windows.

TCRcloud uses the AIRR Data Commons API and needs AIRR compliant data as input

Usage

To create a wordcloud

$ TCRcloud cloud -a AIRR_rearrangements_file.tsv

By default TCRcloud colours the CDR3 based on the Vgene but you can provide a json file that atributes colours in Hex format to specific sequences:

{
"#FF0000":["CAASITGNQFYF","CAVREDGTSGSARQLTF"],
"#0000FF":["CAVMDSNYQLIW"]
}

The sequences not in the file will be coloured grey.

To use your custom colours for the word cloud

$ TCRcloud cloud -a AIRR_rearrangements_file.tsv -c colours.json

To create a radar plot comparing diversity metrics

$ TCRcloud radar -a AIRR_rearrangements_file.tsv

By default TCRcloud uses repertoire_id but you can create a legend with the text you want by providing a json file:

{
"2839362682105696746-242ac113-0001-012":"Twin 2A",
"2939134772391776746-242ac113-0001-012":"Twin 2B"
}  

To create a radar plot with your desired legend

$ TCRcloud radar -a AIRR_rearrangements_file.tsv -l legend.json

Using TCRcloud you can download rearragements files from the AIRR compliant databases based on AIRR repertoire metadata files

To download AIRR rearrangements files

$ TCRcloud download -a AIRR_repertoire_file.json

TCRcloud provides some test data to experiment the tool. The data is one twin pair from the monozygotic twins study from the Mark Davis lab (DOI: 10.1038/ncomms11112)

To download the test data repertoire file

$ TCRcloud testdata

After having the testdata.airr.json file you can use the download function included in TCRcloud to get the matching rearragements file.

Examples:

TRA CDR3 word cloud alpha

TRB CDR3 word cloud beta

TRG CDR3 word cloud gamma

TRD CDR3 word cloud delta

Diversity comparison

Comparing here the αβ repertoire from one twin pair from the monozygotic twins study from the Mark Davis lab (DOI: 10.1038/ncomms11112)

radar

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

TCRcloud-1.1.0.tar.gz (11.7 kB view hashes)

Uploaded Source

Built Distribution

TCRcloud-1.1.0-py3-none-any.whl (14.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page