.. xpore documentation master file, created by
   sphinx-quickstart on Sat Dec 21 06:31:05 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to xPore's documentation!
=================================
xPore is a Python package for detection of differentail RNA modifications from Nanopore sequencing data.

To install the latest release, run::

    pip install xpore
    pyensembl install --release 91 --species homo_sapiens  # Please specify the compatible Ensembl release with your data when you install it.

See our :ref:`Installation page <installation>` for details.

To detect differential modifications, you can follow the instructions in our :ref:`Quickstart page <quickstart>`. 

Contents
------------------
.. toctree::
   :maxdepth: 1
   
   installation
   quickstart
   outputtable
   configuration
   preparation
   scripts

Contacts
--------
xPore is maintained by `Ploy N. Pratanwanich <https://github.com/ploy-rukawa>`_ and `Jonathan Goeke <https://github.com/jonathangoeke>`_ from the Genome Institute of Singapore, A*STAR. 

If you want to contribute, please leave an issue in `our repo <https://github.com/GoekeLab/xpore>`_

Thank you!

