tidytcells


Nametidytcells JSON
Version 2.1.3.post1 PyPI version JSON
download
home_pageNone
SummaryStandardise TR/MH data
upload_time2024-12-05 23:37:04
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords immunology bioinformatics tcr tr mhc mh hla t cell imgt
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">

<img src="https://raw.githubusercontent.com/yutanagano/tidytcells/main/tidytcells.png" width=700>
<br><br>

![Tests](https://github.com/yutanagano/tidytcells/actions/workflows/tests.yaml/badge.svg)
[![Docs](https://readthedocs.org/projects/tidytcells/badge/?version=latest)](https://tidytcells.readthedocs.io)
[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/yutanagano/tidytcells?tab=MIT-1-ov-file#readme)
[![DOI](https://img.shields.io/badge/DOI-10.3389/fimmu.2023.1276106-pink)](https://www.frontiersin.org/journals/immunology/articles/10.3389/fimmu.2023.1276106)

### Check out the [documentation page](https://tidytcells.readthedocs.io).

</div>

---

`tidytcells` is a lightweight python package that cleans and standardizes T cell receptor (TR) and Major Histocompatibility (MH) 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-standardized TR datasets.
It is often difficult to compile TR data from multiple sources because the formats/nomenclature of how each dataset encodes TR and MH gene names are slightly different, or even inconsistent within themselves.
`tidytcells` can ameliorate this issue by auto-correcting and auto-standardizing your data.

## Installation

```bash
$ pip install tidytcells
```

## Citing tidytcells

Please cite [our manuscript](https://www.frontiersin.org/journals/immunology/articles/10.3389/fimmu.2023.1276106).

### BibTex
```bibtex
@ARTICLE{10.3389/fimmu.2023.1276106,
         AUTHOR={Nagano, Yuta  and Chain, Benjamin },
         TITLE={tidytcells: standardizer for TR/MH nomenclature},
         JOURNAL={Frontiers in Immunology},
         VOLUME={14},
         YEAR={2023},
         URL={https://www.frontiersin.org/journals/immunology/articles/10.3389/fimmu.2023.1276106},
         DOI={10.3389/fimmu.2023.1276106},
         ISSN={1664-3224}
}
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "tidytcells",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Yuta Nagano <yutanagano51@proton.me>",
    "keywords": "immunology, bioinformatics, TCR, TR, MHC, MH, HLA, T cell, IMGT",
    "author": null,
    "author_email": "Yuta Nagano <yutanagano51@proton.me>",
    "download_url": "https://files.pythonhosted.org/packages/fb/4b/0726c9112b9dfc10229e9684afb70e4700b1d692426218807d4798df6b40/tidytcells-2.1.3.post1.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n\n<img src=\"https://raw.githubusercontent.com/yutanagano/tidytcells/main/tidytcells.png\" width=700>\n<br><br>\n\n![Tests](https://github.com/yutanagano/tidytcells/actions/workflows/tests.yaml/badge.svg)\n[![Docs](https://readthedocs.org/projects/tidytcells/badge/?version=latest)](https://tidytcells.readthedocs.io)\n[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/yutanagano/tidytcells?tab=MIT-1-ov-file#readme)\n[![DOI](https://img.shields.io/badge/DOI-10.3389/fimmu.2023.1276106-pink)](https://www.frontiersin.org/journals/immunology/articles/10.3389/fimmu.2023.1276106)\n\n### Check out the [documentation page](https://tidytcells.readthedocs.io).\n\n</div>\n\n---\n\n`tidytcells` is a lightweight python package that cleans and standardizes T cell receptor (TR) and Major Histocompatibility (MH) data to be [IMGT](https://www.imgt.org/)-compliant.\nThe main purpose of the package is to solve the problem of parsing and collating together non-standardized TR datasets.\nIt is often difficult to compile TR data from multiple sources because the formats/nomenclature of how each dataset encodes TR and MH gene names are slightly different, or even inconsistent within themselves.\n`tidytcells` can ameliorate this issue by auto-correcting and auto-standardizing your data.\n\n## Installation\n\n```bash\n$ pip install tidytcells\n```\n\n## Citing tidytcells\n\nPlease cite [our manuscript](https://www.frontiersin.org/journals/immunology/articles/10.3389/fimmu.2023.1276106).\n\n### BibTex\n```bibtex\n@ARTICLE{10.3389/fimmu.2023.1276106,\n         AUTHOR={Nagano, Yuta  and Chain, Benjamin },\n         TITLE={tidytcells: standardizer for TR/MH nomenclature},\n         JOURNAL={Frontiers in Immunology},\n         VOLUME={14},\n         YEAR={2023},\n         URL={https://www.frontiersin.org/journals/immunology/articles/10.3389/fimmu.2023.1276106},\n         DOI={10.3389/fimmu.2023.1276106},\n         ISSN={1664-3224}\n}\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Standardise TR/MH data",
    "version": "2.1.3.post1",
    "project_urls": {
        "Documentation": "https://tidytcells.readthedocs.io",
        "Homepage": "https://tidytcells.readthedocs.io",
        "Issues": "https://github.com/yutanagano/tidytcells/issues",
        "Repository": "https://github.com/yutanagano/tidytcells"
    },
    "split_keywords": [
        "immunology",
        " bioinformatics",
        " tcr",
        " tr",
        " mhc",
        " mh",
        " hla",
        " t cell",
        " imgt"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4c429b0149b46be7509355e4487991c5d3477e91e94176998fcce48b197433b0",
                "md5": "11f45fca3d285970c786fe8d082a42fd",
                "sha256": "0bc2663b828dc4b8f884a50d510aa7e6eeeb97d5cb7197e13c50df582be0b184"
            },
            "downloads": -1,
            "filename": "tidytcells-2.1.3.post1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "11f45fca3d285970c786fe8d082a42fd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 90580,
            "upload_time": "2024-12-05T23:37:02",
            "upload_time_iso_8601": "2024-12-05T23:37:02.015107Z",
            "url": "https://files.pythonhosted.org/packages/4c/42/9b0149b46be7509355e4487991c5d3477e91e94176998fcce48b197433b0/tidytcells-2.1.3.post1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "fb4b0726c9112b9dfc10229e9684afb70e4700b1d692426218807d4798df6b40",
                "md5": "c1f06bfb00213f0695150ac21fb7020b",
                "sha256": "abeee6d57ca87857f973e0d01acf77337655d6f43ec6807a57e0f890d9142bae"
            },
            "downloads": -1,
            "filename": "tidytcells-2.1.3.post1.tar.gz",
            "has_sig": false,
            "md5_digest": "c1f06bfb00213f0695150ac21fb7020b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 79255,
            "upload_time": "2024-12-05T23:37:04",
            "upload_time_iso_8601": "2024-12-05T23:37:04.374918Z",
            "url": "https://files.pythonhosted.org/packages/fb/4b/0726c9112b9dfc10229e9684afb70e4700b1d692426218807d4798df6b40/tidytcells-2.1.3.post1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-05 23:37:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "yutanagano",
    "github_project": "tidytcells",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "tidytcells"
}
        
Elapsed time: 0.38744s