Metadata-Version: 2.1
Name: tidytcells
Version: 1.6.0
Summary: Standardise TCR/MHC data.
Author: Yuta Nagano
Author-email: yutanagano51@proton.me
Keywords: immunology,bioinformatics,TCR,MHC,HLA,T cell,IMGT
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
License-File: LICENSE.txt

# tidytcells

![Tests](https://github.com/yutanagano/tidytcells/actions/workflows/tests.yaml/badge.svg)
![Docs](https://readthedocs.org/projects/tidytcells/badge/?version=latest)
![License](https://img.shields.io/badge/license-MIT-blue)

`tidytcells` is a lightweight python package that cleans and standardises T cell receptor (TCR) and Major Histocompatibility Complex (MHC) data to be [IMGT](https://www.imgt.org/)-compliant.
The main purpose of the package is to solve the problem of parsing and collating together non-standardised TCR datasets.
It is often difficult to compile TCR data from multiple sources because the formats/nomenclature of how each dataset encodes TCR and MHC gene names are slightly different, or even inconsistent within themselves.
`tidytcells` can ameliorate this issue by auto-correcting and auto-standardising your data!

## Installation

### Via [PyPI](https://pypi.org/project/tidytcells/) (recommended)

`tidytcells` can be installed using `pip`:

```bash
$ pip install tidytcells
```

### From [source](https://github.com/yutanagano/tidytcells)

The source code for the package is available [on Github](https://github.com/yutanagano/tidytcells).
To install from source, clone the git repository, and run:

```bash
$ pip install .
```

from inside the project root directory.

## Useful links

- [Documentation](https://tidytcells.readthedocs.io)
- [PyPI page](https://pypi.org/project/tidytcells)
