mutalyzer-hgvs-parser


Namemutalyzer-hgvs-parser JSON
Version 0.3.5 PyPI version JSON
download
home_pagehttps://github.com/mutalyzer/hgvs-parser
SummaryMutalyzer HGVS variant description parser.
upload_time2023-08-17 09:37:56
maintainer
docs_urlNone
authorMihai Lefter
requires_python
licenseMIT
keywords mutalyzer hgvs description parser genomic
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Mutalyzer HGVS Parser
=====================

.. image:: https://img.shields.io/github/last-commit/mutalyzer/hgvs-parser.svg
   :target: https://github.com/mutalyzer/hgvs-parser/graphs/commit-activity
.. image:: https://readthedocs.org/projects/mutalyzer-hgvs-parser/badge/?version=latest
   :target: https://mutalyzer-hgvs-parser.readthedocs.io/en/latest
.. image:: https://img.shields.io/github/release-date/mutalyzer/hgvs-parser.svg
   :target: https://github.com/mutalyzer/hgvs-parser/releases
.. image:: https://img.shields.io/github/release/mutalyzer/hgvs-parser.svg
   :target: https://github.com/mutalyzer/hgvs-parser/releases
.. image:: https://img.shields.io/pypi/v/mutalyzer-hgvs-parser.svg
   :target: https://pypi.org/project/mutalyzer-hgvs-parser/
.. image:: https://img.shields.io/github/languages/code-size/mutalyzer/hgvs-parser.svg
   :target: https://github.com/mutalyzer/hgvs-parser
.. image:: https://img.shields.io/github/languages/count/mutalyzer/hgvs-parser.svg
   :target: https://github.com/mutalyzer/hgvs-parser
.. image:: https://img.shields.io/github/languages/top/mutalyzer/hgvs-parser.svg
   :target: https://github.com/mutalyzer/hgvs-parser
.. image:: https://img.shields.io/github/license/mutalyzer/hgvs-parser.svg
   :target: https://raw.githubusercontent.com/mutalyzer/hgvs-parser/master/LICENSE.md

----

Package to syntax check and convert Mutalyzer HGVS variant descriptions into
a dictionary model to easily access descriptions information in a
programmatically manner.

**Features:**

- Accepts HGVS descriptions with multiple variants (one HGVS allele).
- Any description sub-part can be parsed and converted as well.
- Supports common deviations to the HGVS guidelines.
- Command line and library interfaces available.


Quick start
-----------

Parse and convert a description from the command line:

.. code-block:: console

    $ mutalyzer_hgvs_parser -c "NG_012337.1:c.20del"
    {
      "reference": {
        "id": "NG_012337.1"
      },
      "coordinate_system": "c",
      "variants": [
        {
          "location": {
            "type": "point",
            "position": 20
          },
          "type": "deletion",
          "source": "reference"
        }
      ]
    }


The ``to_model()`` function can be used for the same purpose:

.. code:: python

    >>> from mutalyzer_hgvs_parser import to_model
    >>> model = to_model("NG_012337.1:c.20del")
    >>> model['reference']
    {'id': 'NG_012337.1'}


Please see ReadTheDocs_ for the latest documentation.

.. _ReadTheDocs: https://mutalyzer-hgvs-parser.readthedocs.io/en/latest/

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/mutalyzer/hgvs-parser",
    "name": "mutalyzer-hgvs-parser",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "Mutalyzer,HGVS,description,parser,genomic",
    "author": "Mihai Lefter",
    "author_email": "M.Lefter@lumc.nl",
    "download_url": "https://files.pythonhosted.org/packages/81/69/7cbe0e1a213b21f304bc3fe06cbfbf3ad49bd876f55844402bf9ead1abf1/mutalyzer_hgvs_parser-0.3.5.tar.gz",
    "platform": null,
    "description": "Mutalyzer HGVS Parser\n=====================\n\n.. image:: https://img.shields.io/github/last-commit/mutalyzer/hgvs-parser.svg\n   :target: https://github.com/mutalyzer/hgvs-parser/graphs/commit-activity\n.. image:: https://readthedocs.org/projects/mutalyzer-hgvs-parser/badge/?version=latest\n   :target: https://mutalyzer-hgvs-parser.readthedocs.io/en/latest\n.. image:: https://img.shields.io/github/release-date/mutalyzer/hgvs-parser.svg\n   :target: https://github.com/mutalyzer/hgvs-parser/releases\n.. image:: https://img.shields.io/github/release/mutalyzer/hgvs-parser.svg\n   :target: https://github.com/mutalyzer/hgvs-parser/releases\n.. image:: https://img.shields.io/pypi/v/mutalyzer-hgvs-parser.svg\n   :target: https://pypi.org/project/mutalyzer-hgvs-parser/\n.. image:: https://img.shields.io/github/languages/code-size/mutalyzer/hgvs-parser.svg\n   :target: https://github.com/mutalyzer/hgvs-parser\n.. image:: https://img.shields.io/github/languages/count/mutalyzer/hgvs-parser.svg\n   :target: https://github.com/mutalyzer/hgvs-parser\n.. image:: https://img.shields.io/github/languages/top/mutalyzer/hgvs-parser.svg\n   :target: https://github.com/mutalyzer/hgvs-parser\n.. image:: https://img.shields.io/github/license/mutalyzer/hgvs-parser.svg\n   :target: https://raw.githubusercontent.com/mutalyzer/hgvs-parser/master/LICENSE.md\n\n----\n\nPackage to syntax check and convert Mutalyzer HGVS variant descriptions into\na dictionary model to easily access descriptions information in a\nprogrammatically manner.\n\n**Features:**\n\n- Accepts HGVS descriptions with multiple variants (one HGVS allele).\n- Any description sub-part can be parsed and converted as well.\n- Supports common deviations to the HGVS guidelines.\n- Command line and library interfaces available.\n\n\nQuick start\n-----------\n\nParse and convert a description from the command line:\n\n.. code-block:: console\n\n    $ mutalyzer_hgvs_parser -c \"NG_012337.1:c.20del\"\n    {\n      \"reference\": {\n        \"id\": \"NG_012337.1\"\n      },\n      \"coordinate_system\": \"c\",\n      \"variants\": [\n        {\n          \"location\": {\n            \"type\": \"point\",\n            \"position\": 20\n          },\n          \"type\": \"deletion\",\n          \"source\": \"reference\"\n        }\n      ]\n    }\n\n\nThe ``to_model()`` function can be used for the same purpose:\n\n.. code:: python\n\n    >>> from mutalyzer_hgvs_parser import to_model\n    >>> model = to_model(\"NG_012337.1:c.20del\")\n    >>> model['reference']\n    {'id': 'NG_012337.1'}\n\n\nPlease see ReadTheDocs_ for the latest documentation.\n\n.. _ReadTheDocs: https://mutalyzer-hgvs-parser.readthedocs.io/en/latest/\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Mutalyzer HGVS variant description parser.",
    "version": "0.3.5",
    "project_urls": {
        "Homepage": "https://github.com/mutalyzer/hgvs-parser"
    },
    "split_keywords": [
        "mutalyzer",
        "hgvs",
        "description",
        "parser",
        "genomic"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "00d28342904d75657f68b8dc611759e94ae251b239d9805cd876189069588c26",
                "md5": "60f5e06779924b7146fe2f34f66c7092",
                "sha256": "d2dab2ffeccf74d2e6d7c4c369d3af08f69903fee5504db02ee1e5817dfb418a"
            },
            "downloads": -1,
            "filename": "mutalyzer_hgvs_parser-0.3.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "60f5e06779924b7146fe2f34f66c7092",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 28095,
            "upload_time": "2023-08-17T09:37:54",
            "upload_time_iso_8601": "2023-08-17T09:37:54.937096Z",
            "url": "https://files.pythonhosted.org/packages/00/d2/8342904d75657f68b8dc611759e94ae251b239d9805cd876189069588c26/mutalyzer_hgvs_parser-0.3.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "81697cbe0e1a213b21f304bc3fe06cbfbf3ad49bd876f55844402bf9ead1abf1",
                "md5": "fa9e94b2bbec2ead11804e44c42e561f",
                "sha256": "7cabd8ad0db5fd746c591590ad8c462b5b616ce0b5e35e74703c56af54c7dbce"
            },
            "downloads": -1,
            "filename": "mutalyzer_hgvs_parser-0.3.5.tar.gz",
            "has_sig": false,
            "md5_digest": "fa9e94b2bbec2ead11804e44c42e561f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 24026,
            "upload_time": "2023-08-17T09:37:56",
            "upload_time_iso_8601": "2023-08-17T09:37:56.851831Z",
            "url": "https://files.pythonhosted.org/packages/81/69/7cbe0e1a213b21f304bc3fe06cbfbf3ad49bd876f55844402bf9ead1abf1/mutalyzer_hgvs_parser-0.3.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-17 09:37:56",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "mutalyzer",
    "github_project": "hgvs-parser",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mutalyzer-hgvs-parser"
}
        
Elapsed time: 0.10581s