Skip to content

Commit

Permalink
Merge pull request #49 from GoekeLab/readme-update
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
ploy-np authored Mar 1, 2021
2 parents 740bb6d + 205214d commit acd595e
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,54 @@
![alt text](https://github.com/GoekeLab/xpore/blob/master/figures/xpore_textlogo.png "xPore")

Python package for detection of differential RNA modifications from direct RNA sequencing.


[![PyPI version](https://badge.fury.io/py/xpore.svg)](https://badge.fury.io/py/xpore)
[![Documentation Status](https://readthedocs.org/projects/xpore/badge/?version=latest)](https://xpore.readthedocs.io/en/latest/?badge=latest)
[![Downloads](https://pepy.tech/badge/xpore)](https://pepy.tech/project/xpore)


---

### PyPI installation (recommended)

xPore is a Python package for identification and quantification of differential RNA modifications from direct RNA sequencing.


### Installation

xPore requires [Python3](https://www.python.org).
To install the latest release, run
To install the latest release with PyPI (recommended), run

```sh
$ pip install xpore
$ pyensembl install --release 91 --species homo_sapiens # please specify the compatible Ensembl release with your data when you install it.
```
### Documentation

Please refer to the xPore documention ([https://xpore.readthedocs.io](https://xpore.readthedocs.io)) for additional information, a quick start guide, and details on the data processing and output file format.

See our documentation [here](https://xpore.readthedocs.io)!
xPore is described in detail in a preprint (https://www.biorxiv.org/content/10.1101/2020.06.18.160010v1)

### Release History

The current release is xPore v0.5.6.

Please refer to the github release history for previous releases: https://github.com/GoekeLab/xpore/releases

---

### Preprint
### Citing xPore

If you use xPore in your research, please cite

[Ploy N. Pratanwanich, Ploy N. et al. "Detection of differential RNA modifications from direct RNA sequencing of human cell lines". *bioRxiv* (2020) doi: https://doi.org/10.1101/2020.06.18.160010](https://www.biorxiv.org/content/10.1101/2020.06.18.160010v1)

Please check out our preprint "Detection of differential RNA modifications from direct RNA sequencing of human cell lines" [here](https://www.biorxiv.org/content/10.1101/2020.06.18.160010v1).

---

### Contacts
### Contact

xPore is maintained by [Ploy N. Pratanwanich](https://github.com/ploy-np) 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.
If you want to contribute, please leave an issue.

Thank you!

0 comments on commit acd595e

Please sign in to comment.