Metadata-Version: 2.1
Name: bio2bel-hgnc
Version: 0.0.6.dev0
Summary: A package for converting HGNC to BEL
Home-page: https://github.com/bio2bel/hgnc
Author: Charles Tapley Hoyt
Author-email: charles.hoyt@scai.fraunhofer.de
Maintainer: Charles Tapley Hoyt
Maintainer-email: charles.hoyt@scai.fraunhofer.de
License: MIT License
Platform: UNKNOWN
Requires-Dist: pybel[deployment] (>=0.11.1)
Requires-Dist: bio2bel (>=0.0.10)
Requires-Dist: tqdm
Requires-Dist: sqlalchemy
Requires-Dist: click
Requires-Dist: pyhgnc

Bio2BEL HGNC |build| |coverage| |documentation| |zenodo|
========================================================
This package creates:

- HGNC BEL namespace
- HGNC gene families BEL namespace,
- HGNC gene family membership BEL Script
- orthology BEL script

Installation |pypi_version| |python_versions| |pypi_license|
------------------------------------------------------------
``bio2bel_hgnc`` can be installed easily from `PyPI <https://pypi.python.org/pypi/bio2bel_hgnc>`_ with the
following code in your favorite terminal:

.. code-block:: sh

    $ python3 -m pip install bio2bel_hgnc

or from the latest code on `GitHub <https://github.com/bio2bel/hgnc>`_ with:

.. code-block:: sh

    $ python3 -m pip install git+https://github.com/bio2bel/hgnc.git@master

Setup
-----
HGNC can be downloaded and populated from either the Python REPL or the automatically installed command line
utility.

Python REPL
~~~~~~~~~~~
.. code-block:: python

    >>> import bio2bel_hgnc
    >>> hgnc_manager = bio2bel_hgnc.Manager()
    >>> hgnc_manager.populate()

Command Line Utility
~~~~~~~~~~~~~~~~~~~~
.. code-block:: bash

    bio2bel_hgnc populate

Citations
---------
- Gray KA, *et al*. `genenames.org: the HGNC resources in 2015 <http://www.ncbi.nlm.nih.gov/pubmed/25361968>`_. Nucleic
  Acids Res. 2015 Jan;43(Database issue):D1079-85

Acknowledgements
----------------
- This package heavily relies on Andrej Konotopez's package `PyHGNC <https://github.com/lekono/pyhgnc>`_

.. |build| image:: https://travis-ci.org/bio2bel/hgnc.svg?branch=master
    :target: https://travis-ci.org/bio2bel/hgnc
    :alt: Build Status

.. |coverage| image:: https://codecov.io/gh/bio2bel/hgnc/coverage.svg?branch=master
    :target: https://codecov.io/gh/bio2bel/hgnc?branch=master
    :alt: Coverage Status

.. |documentation| image:: http://readthedocs.org/projects/bio2bel-hgnc/badge/?version=latest
    :target: http://bio2bel.readthedocs.io/projects/hgnc/en/latest/?badge=latest
    :alt: Documentation Status

.. |climate| image:: https://codeclimate.com/github/bio2bel/hgnc/badges/gpa.svg
    :target: https://codeclimate.com/github/bio2bel/hgnc
    :alt: Code Climate

.. |python_versions| image:: https://img.shields.io/pypi/pyversions/bio2bel_hgnc.svg
    :alt: Stable Supported Python Versions

.. |pypi_version| image:: https://img.shields.io/pypi/v/bio2bel_hgnc.svg
    :alt: Current version on PyPI

.. |pypi_license| image:: https://img.shields.io/pypi/l/bio2bel_hgnc.svg
    :alt: MIT License

.. |zenodo| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1162644.svg
    :target: https://doi.org/10.5281/zenodo.1162644


