Skip to main content

SONIA is a python 3.6 software developed to infer selection pressures on features of amino acid CDR3 sequences. The model can be used to calculate the probability of observing any sequence after selection and sample from the selected repertoire.

Project description

SONIA

SONIA is a python 3.6/2.7 software developed to infer selection pressures on features of amino acid CDR3 sequences. The inference is based on maximizing the likelihood of observing a selected data sample given a representative pre-selected sample. This method was first used in Elhanati et al (2014) to study thymic selection. For this purpose, the pre-selected sample can be generated internally using the OLGA software package, but SONIA allows it also to be supplied externally, in the same way the data sample is provided.

SONIA takes as input TCR CDR3 amino acid sequences, with or without per sequence lists of possible V and J genes suspected to be used in the recombination process for this sequence. Its output is selection factors for each amino acid ,(relative) position , CDR3 length combinations, and also for each V and J gene choice. These selection factors can be used to calculate sequence level selection factors which indicate how more or less represented this sequence would be in the selected pool as compared to the the pre-selected pool. These in turn could be used to calculate the probability to observe any sequence after selection and sample from the selected repertoire.

Version

Latest released version: 0.0.45

Installation

SONIA is a python 2.7/3.6 software. It is available on PyPI and can be downloaded and installed through pip:

pip install sonia.

SONIA is also available on GitHub. The command line entry points can be installed by using the setup.py script:

python setup.py install.

Sometimes pip fails to install the dependencies correctly. Thus, if you get any error try first to install the dependencies separately:

pip install tensorflow
pip install matplotlib
pip install olga
pip install sonia 

References

  1. Sethna Z, Isacchini G, Dupic T, Mora T, Walczak AM, Elhanati Y, Population variability in the generation and thymic selection of T-cell repertoires, (2020) bioRxiv, https://doi.org/10.1101/2020.01.08.899682
  2. Isacchini G, Sethna Z, Elhanati Y ,Nourmohammad A, Mora T, Walczak AM, Generative models of T-cell receptor sequences, (2020) Phys. Rev. E 101, 062414, https://journals.aps.org/pre/abstract/10.1103/PhysRevE.101.062414
  3. Elhanati Y, Murugan A , Callan CGJ , Mora T , Walczak AM, Quantifying selection in immune receptor repertoires, PNAS July 8, 2014 111 (27) 9875-9880, https://doi.org/10.1073/pnas.1409572111

Documentation

Extensive documentation can be found here

Contact

Any issues or questions should be addressed to us.

License

Free use of SONIA is granted under the terms of the GNU General Public License version 3 (GPLv3).

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

sonia-0.2.1.tar.gz (757.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sonia-0.2.1-py3-none-any.whl (772.6 kB view details)

Uploaded Python 3

File details

Details for the file sonia-0.2.1.tar.gz.

File metadata

  • Download URL: sonia-0.2.1.tar.gz
  • Upload date:
  • Size: 757.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.6

File hashes

Hashes for sonia-0.2.1.tar.gz
Algorithm Hash digest
SHA256 c6d8aa22ce33cf3dd63eaf5fbc48cfe2af914bbfb805c5a7093c71791dabf085
MD5 07f574baa1bef986d4e0dc708f22e37a
BLAKE2b-256 64f8df0fc9e81f8a3470e587e3d04cf3a2465249283b8d97c29115358a0c8cb9

See more details on using hashes here.

File details

Details for the file sonia-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: sonia-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 772.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.10.6

File hashes

Hashes for sonia-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c90fc730e549124e8e19c12432ec2d5389bde6294ff0bd2e1dec8981e822a798
MD5 95f8a4084ca1606908f8808b58139ab9
BLAKE2b-256 d68ab6deadeedb93327ca1f75ad0686a389197ad81767082af4757528c85519b

See more details on using hashes here.

Supported by

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