Mutalyzer HGVS Parser
=====================
.. image:: https://img.shields.io/github/last-commit/mutalyzer/spdi-parser.svg
:target: https://github.com/mutalyzer/spdi-parser/graphs/commit-activity
.. image:: https://readthedocs.org/projects/mutalyzer-spdi-parser/badge/?version=latest
:target: https://mutalyzer-spdi-parser.readthedocs.io/en/latest
.. image:: https://img.shields.io/github/release-date/mutalyzer/spdi-parser.svg
:target: https://github.com/mutalyzer/spdi-parser/releases
.. image:: https://img.shields.io/github/release/mutalyzer/spdi-parser.svg
:target: https://github.com/mutalyzer/spdi-parser/releases
.. image:: https://img.shields.io/pypi/v/mutalyzer-spdi-parser.svg
:target: https://pypi.org/project/mutalyzer-spdi-parser/
.. image:: https://img.shields.io/github/languages/code-size/mutalyzer/spdi-parser.svg
:target: https://github.com/mutalyzer/spdi-parser
.. image:: https://img.shields.io/github/languages/count/mutalyzer/spdi-parser.svg
:target: https://github.com/mutalyzer/spdi-parser
.. image:: https://img.shields.io/github/languages/top/mutalyzer/spdi-parser.svg
:target: https://github.com/mutalyzer/spdi-parser
.. image:: https://img.shields.io/github/license/mutalyzer/spdi-parser.svg
:target: https://raw.githubusercontent.com/mutalyzer/spdi-parser/master/LICENSE.md
----
Package to syntax check and convert SPDI descriptions into a dictionary model.
Quick start
-----------
Parse and convert a description from the command line:
.. code-block:: console
$ mutalyzer_spdi_parser -cs "NG_012337.3:10:C:T"
{
"seq_id": "NG_012337.3",
"position": 10,
"deleted_sequence": "C",
"inserted_sequence": "T"
}
$ mutalyzer_spdi_parser -ch "NG_012337.3:10:C:T"
{
"type": "description_dna",
"reference": {
"id": "NG_012337.3"
},
"variants": [
{
"type": "deletion_insertion",
"location": {
"type": "range",
"start": {
"type": "point",
"position": 10
},
"end": {
"type": "point",
"position": 11
}
},
"deleted": [
{
"sequence": "C",
"source": "description"
}
],
"inserted": [
{
"sequence": "T",
"source": "description"
}
]
}
]
}
The ``to_hgvs_internal_model()`` function can be used to obtain the equivalent
HGVS dictionary model (deletion insertion variants with internal locations and
indexing):
.. code:: python
>>> from mutalyzer_spdi_parser import to_hgvs_internal_model
>>> model = to_hgvs_internal_model("NG_012337.3:10:C:T")
>>> model['reference']
{'id': 'NG_012337.3'}
Raw data
{
"_id": null,
"home_page": "https://github.com/mutalyzer/spdi-parser",
"name": "mutalyzer-spdi-parser",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Mutalyzer, HGVS, SPDI, description, parser, genomic",
"author": "Mihai Lefter",
"author_email": "M.Lefter@lumc.nl",
"download_url": "https://files.pythonhosted.org/packages/9f/70/f05095de552332a40e8403b08c392a6c558287d836b1001ceaad443876bf/mutalyzer_spdi_parser-0.3.1.tar.gz",
"platform": null,
"description": "Mutalyzer HGVS Parser\n=====================\n\n.. image:: https://img.shields.io/github/last-commit/mutalyzer/spdi-parser.svg\n :target: https://github.com/mutalyzer/spdi-parser/graphs/commit-activity\n.. image:: https://readthedocs.org/projects/mutalyzer-spdi-parser/badge/?version=latest\n :target: https://mutalyzer-spdi-parser.readthedocs.io/en/latest\n.. image:: https://img.shields.io/github/release-date/mutalyzer/spdi-parser.svg\n :target: https://github.com/mutalyzer/spdi-parser/releases\n.. image:: https://img.shields.io/github/release/mutalyzer/spdi-parser.svg\n :target: https://github.com/mutalyzer/spdi-parser/releases\n.. image:: https://img.shields.io/pypi/v/mutalyzer-spdi-parser.svg\n :target: https://pypi.org/project/mutalyzer-spdi-parser/\n.. image:: https://img.shields.io/github/languages/code-size/mutalyzer/spdi-parser.svg\n :target: https://github.com/mutalyzer/spdi-parser\n.. image:: https://img.shields.io/github/languages/count/mutalyzer/spdi-parser.svg\n :target: https://github.com/mutalyzer/spdi-parser\n.. image:: https://img.shields.io/github/languages/top/mutalyzer/spdi-parser.svg\n :target: https://github.com/mutalyzer/spdi-parser\n.. image:: https://img.shields.io/github/license/mutalyzer/spdi-parser.svg\n :target: https://raw.githubusercontent.com/mutalyzer/spdi-parser/master/LICENSE.md\n\n----\n\nPackage to syntax check and convert SPDI descriptions into a dictionary model.\n\n\nQuick start\n-----------\n\nParse and convert a description from the command line:\n\n.. code-block:: console\n\n $ mutalyzer_spdi_parser -cs \"NG_012337.3:10:C:T\"\n {\n \"seq_id\": \"NG_012337.3\",\n \"position\": 10,\n \"deleted_sequence\": \"C\",\n \"inserted_sequence\": \"T\"\n }\n\n $ mutalyzer_spdi_parser -ch \"NG_012337.3:10:C:T\"\n {\n \"type\": \"description_dna\",\n \"reference\": {\n \"id\": \"NG_012337.3\"\n },\n \"variants\": [\n {\n \"type\": \"deletion_insertion\",\n \"location\": {\n \"type\": \"range\",\n \"start\": {\n \"type\": \"point\",\n \"position\": 10\n },\n \"end\": {\n \"type\": \"point\",\n \"position\": 11\n }\n },\n \"deleted\": [\n {\n \"sequence\": \"C\",\n \"source\": \"description\"\n }\n ],\n \"inserted\": [\n {\n \"sequence\": \"T\",\n \"source\": \"description\"\n }\n ]\n }\n ]\n }\n\n\nThe ``to_hgvs_internal_model()`` function can be used to obtain the equivalent\nHGVS dictionary model (deletion insertion variants with internal locations and\nindexing):\n\n.. code:: python\n\n >>> from mutalyzer_spdi_parser import to_hgvs_internal_model\n >>> model = to_hgvs_internal_model(\"NG_012337.3:10:C:T\")\n >>> model['reference']\n {'id': 'NG_012337.3'}\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mutalyzer SPDI variant description parser.",
"version": "0.3.1",
"project_urls": {
"Homepage": "https://github.com/mutalyzer/spdi-parser"
},
"split_keywords": [
"mutalyzer",
" hgvs",
" spdi",
" description",
" parser",
" genomic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e615627fbc7d918c8ae278ac8ad01691fd5fd49bb5cd96517da7fa01937af1ce",
"md5": "bdf4d1757e79ee9de523eba6a79e325b",
"sha256": "07ac3ebf8b3b2cbfcbd1a8d80ec404b74454e59642a79000fdfd174f7b2891e7"
},
"downloads": -1,
"filename": "mutalyzer_spdi_parser-0.3.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bdf4d1757e79ee9de523eba6a79e325b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 7240,
"upload_time": "2024-05-22T13:54:25",
"upload_time_iso_8601": "2024-05-22T13:54:25.149495Z",
"url": "https://files.pythonhosted.org/packages/e6/15/627fbc7d918c8ae278ac8ad01691fd5fd49bb5cd96517da7fa01937af1ce/mutalyzer_spdi_parser-0.3.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f70f05095de552332a40e8403b08c392a6c558287d836b1001ceaad443876bf",
"md5": "0eaf3bae6e51df99cc8d849373909eb6",
"sha256": "6211cf4feb548298a8227709511e983621928e0442af4f96d27a8d2a5d3b6af7"
},
"downloads": -1,
"filename": "mutalyzer_spdi_parser-0.3.1.tar.gz",
"has_sig": false,
"md5_digest": "0eaf3bae6e51df99cc8d849373909eb6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7038,
"upload_time": "2024-05-22T13:54:26",
"upload_time_iso_8601": "2024-05-22T13:54:26.247464Z",
"url": "https://files.pythonhosted.org/packages/9f/70/f05095de552332a40e8403b08c392a6c558287d836b1001ceaad443876bf/mutalyzer_spdi_parser-0.3.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-22 13:54:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mutalyzer",
"github_project": "spdi-parser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mutalyzer-spdi-parser"
}