.. MyGene.info documentation master file, created by
   sphinx-quickstart on Wed May 29 17:15:29 2013.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.



MyGene.info documentation
*************************

Introduction
-------------

.. image:: _static/logo.png
   :align: left
   :height: 100pt
   :alt: mygene.info

.. cssclass:: head-paragraph

  `MyGene.info <http://mygene.info>`_ provides simple-to-use REST web services to query/retrieve gene annotation data. It's designed with **simplicity** and **performance** emphasized. A typical use case is to use it to power a web application which requires querying genes and obtaining common gene annotations. For example, `MyGene.info <http://mygene.info>`_ services are used to power `BioGPS <http://biogps.org>`_.

.. raw:: html

    <style>
    #status {
        margin:0!important;
        line-height:1em!important;
    }

    #status span{
        margin-left:auto;
        margin-right:auto;
        width: 100%;
        display: block;
        text-align: center;
        font-weight: bold;
        font-family: "Open Sans", Arial, sans-serif !important;
    }
    </style>
    <p id="status">
    <span id="status_text"></span>
    </p>
    <script type="text/javascript" src="_static/get_meta.js" charset="utf-8"></script>


.. raw:: html

    <style>
    #twitter-widget-0 {
          width: 100% !important;
          height: 380px !important;
          border: solid thin gray;
          margin-top: 2em;
    }
    </style>

    <a class="twitter-timeline" data-width="300" data-height="500" href="https://twitter.com/mygeneinfo?ref_src=twsrc%5Etfw">Tweets by mygeneinfo</a> <script async src="https://platform.twitter.com/widgets.js" charset="utf-8"></script>

What's new in v3 API
------------------------

* Refseq accession number now contains version
* "ensembl", "refseq" and "accession" contains associations between RNA and protein
* Better mapping between Ensembl and Entrez gene IDs
* JSON structure slightly changed
* and more bugfixes

You can read more details about this version on our `blog <http://mygene.info/blog/mygene-info-v3-is-out>`_

`Migration guide from v2 to v3 API <doc/migration_from_v2.html>`_

Still want to stick with v2 API for a while? It's still there: `v2 API <http://mygene.info/v2/doc>`_, but annotation data there won't be updated any more.

.. include :: doc/quick_start.rst


Documentation
---------------------

.. toctree::
   :maxdepth: 3

   Try it live on interactive API page <http://mygene.info/v3/api>
   doc/migration_from_v2
   doc/data
   doc/release_changes
   doc/query_service
   doc/annotation_service
   doc/response_status_codes
   doc/usage_demo
   doc/packages
   terms


How to cite
------------

See citation page here: http://mygene.info/citation/

FAQ
-------

See FAQ page here: http://mygene.info/faq/

Related links
-------------

* `mygene.info on Github <https://github.com/SuLab/mygene.info>`_


Contact us
-------------------------

* help@mygene.info
* `@mygeneinfo <https://twitter.com/mygeneinfo>`_


.. raw:: html

    <div id="spacer" style="height:300px"></div>


.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`