File: index.rst

package info (click to toggle)
xpore 2.1-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 83,008 kB
  • sloc: python: 1,439; sh: 48; makefile: 19
file content (48 lines) | stat: -rw-r--r-- 1,510 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
.. 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 identification of differentail RNA modifications from Nanopore sequencing data.

To install the latest release, run::

    pip install xpore

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

To check the version of xPore, run::

    xpore -v

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

Contents
------------------
.. toctree::
   :maxdepth: 1
   
   installation
   quickstart
   outputtable
   configuration
   preparation
   data
   cmd
   citing
   help

Contacts
--------
If you use xPore in your research, please cite

Ploy N. Pratanwanich, et al.,Identification of differential RNA modifications from nanopore direct RNA sequencing with xPore. *Nat Biotechnol* (2021), `https://doi.org/10.1038/s41587-021-00949-w <https://doi.org/10.1038/s41587-021-00949-w>`_ 

xPore is maintained by `Ploy N. Pratanwanich <https://github.com/ploy-np>`_, `Yuk Kei Wan <https://github.com/yuukiiwa>`_ 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!