| Name | gene-thesaurus JSON |
| Version |
2.3.0
JSON |
| download |
| home_page | None |
| Summary | GeneThesaurus is a Python package that translates gene aliases and old gene symbols to the current HGNC standard gene symbols. |
| upload_time | 2024-10-09 11:27:17 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Uppsala University, Department of Medical Sciences, Molecular Precision Medicine Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
genomics
gene
hgnc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GeneThesaurus v2.3.0
GeneThesaurus is a Python package that translates between different gene standards using publicly available data from [HGNC](https://www.genenames.org/).
Presently, GeneThesaurus supports translating:
- gene aliases and old gene symbols to the current HGNC standard gene symbols
- gene symbols to ensembl identifiers
- ensembl identifiers to gene symbols
Please get in touch (or consider submitting a pull request to this project) if you need translation between other formats.
# Installation
You can install GeneThesaurus with:
```
pip install gene-thesaurus
```
# Example usage
```
from gene_thesaurus import GeneThesaurus
gt = GeneThesaurus(data_dir='/tmp')
outdated_gene = 'TNFSF2'
up_to_date_gene = 'ETV6'
fake_gene = 'NOTAREALGENE'
input = [outdated_gene, up_to_date_gene, fake_gene]
#############################
### update_gene_symbols() ###
#############################
updated_genes = gt.update_gene_symbols(input)
print(updated_genes)
# {'TNFSF2': 'TNF'}
#########################
### translate_genes() ###
#########################
# Valid values for source and target are 'symbol' and 'ensembl_id'.
translated_genes = gt.translate_genes(input, source='symbol', target='ensembl_id')
print(translated_genes)
{'TNFSF2': 'ENSG00000232810', 'ETV6': 'ENSG00000139083'}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "gene-thesaurus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "genomics, gene, HGNC",
"author": null,
"author_email": "Mariya Lysenkova Wiklander <mariya.lysenkova@medsci.uu.se>",
"download_url": "https://files.pythonhosted.org/packages/be/b1/32c86b1575eb9fe3f41a2647453386c28ceb85aed9cea9f9901f1d0099a6/gene_thesaurus-2.3.0.tar.gz",
"platform": null,
"description": "# GeneThesaurus v2.3.0\n\nGeneThesaurus is a Python package that translates between different gene standards using publicly available data from [HGNC](https://www.genenames.org/).\n\nPresently, GeneThesaurus supports translating:\n- gene aliases and old gene symbols to the current HGNC standard gene symbols\n- gene symbols to ensembl identifiers\n- ensembl identifiers to gene symbols\n\nPlease get in touch (or consider submitting a pull request to this project) if you need translation between other formats.\n\n# Installation\n\nYou can install GeneThesaurus with:\n```\npip install gene-thesaurus\n```\n\n# Example usage\n```\nfrom gene_thesaurus import GeneThesaurus\ngt = GeneThesaurus(data_dir='/tmp')\n\noutdated_gene = 'TNFSF2'\nup_to_date_gene = 'ETV6'\nfake_gene = 'NOTAREALGENE'\ninput = [outdated_gene, up_to_date_gene, fake_gene]\n\n#############################\n### update_gene_symbols() ###\n#############################\n\nupdated_genes = gt.update_gene_symbols(input)\nprint(updated_genes)\n# {'TNFSF2': 'TNF'}\n\n#########################\n### translate_genes() ###\n#########################\n\n# Valid values for source and target are 'symbol' and 'ensembl_id'.\n\ntranslated_genes = gt.translate_genes(input, source='symbol', target='ensembl_id')\nprint(translated_genes)\n{'TNFSF2': 'ENSG00000232810', 'ETV6': 'ENSG00000139083'}\n\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Uppsala University, Department of Medical Sciences, Molecular Precision Medicine Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "GeneThesaurus is a Python package that translates gene aliases and old gene symbols to the current HGNC standard gene symbols.",
"version": "2.3.0",
"project_urls": {
"Homepage": "https://github.com/Molmed/gene-thesaurus"
},
"split_keywords": [
"genomics",
" gene",
" hgnc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf4e3bd03c0a327aac5eb4021da7ee90d7fa03b1cff0deca4ef271ca2815bd53",
"md5": "5e8f3d5c75405caf51bdfbc901ca3029",
"sha256": "149189333c3eb1e8a9637242ab78d209fb99768dbe67b7213506ef1659ef66a9"
},
"downloads": -1,
"filename": "gene_thesaurus-2.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5e8f3d5c75405caf51bdfbc901ca3029",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 5658,
"upload_time": "2024-10-09T11:27:14",
"upload_time_iso_8601": "2024-10-09T11:27:14.946648Z",
"url": "https://files.pythonhosted.org/packages/cf/4e/3bd03c0a327aac5eb4021da7ee90d7fa03b1cff0deca4ef271ca2815bd53/gene_thesaurus-2.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "beb132c86b1575eb9fe3f41a2647453386c28ceb85aed9cea9f9901f1d0099a6",
"md5": "df72e30704d447c28e5982a1a179b1b4",
"sha256": "747c335226d1638430bd492caf0a715271de424d31c83f5d94065674879f823f"
},
"downloads": -1,
"filename": "gene_thesaurus-2.3.0.tar.gz",
"has_sig": false,
"md5_digest": "df72e30704d447c28e5982a1a179b1b4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5498,
"upload_time": "2024-10-09T11:27:17",
"upload_time_iso_8601": "2024-10-09T11:27:17.136149Z",
"url": "https://files.pythonhosted.org/packages/be/b1/32c86b1575eb9fe3f41a2647453386c28ceb85aed9cea9f9901f1d0099a6/gene_thesaurus-2.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 11:27:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Molmed",
"github_project": "gene-thesaurus",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "gene-thesaurus"
}
