Skip to content

Commit d33e20e

Browse files
updated README to rst
1 parent 621dc9e commit d33e20e

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

README.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

README.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
|PyPI| |Docs|
2+
3+
.. |PyPI| image:: https://img.shields.io/pypi/v/diffxpy.svg
4+
:target: https://pypi.org/project/diffxpy
5+
.. |Docs| image:: https://readthedocs.com/projects/diffxpy/badge/?version=latest
6+
:target: https://diffxpy.readthedocs.io
7+
8+
# Fast and scalable differential expression analysis on single-cell RNA-seq data
9+
diffxpy covers a wide range of differential expression analysis scenarios encountered in single-cell RNA-seq scenarios
10+
and integrates into scanpy_ workflows.
11+
Import diffxpy as `import diffxpy.api as de` to access the following differential expression analysis-related tools:
12+
13+
1. *differential expression analysis* in the module `de.test.*`
14+
2. *gene set enrichment analysis* based on differential expression calls in the module `de.enrich.*`
15+
16+
Refer to the documentation_ and the tutorials_ for details of these modules.
17+
18+
.. _scanpy: https://github.com/theislab/scanpy
19+
.. _documentation: https://diffxpy.rtfd.io/en/latest
20+
.. _tutorials: https://diffxpy.rtfd.io/en/latest/tutorials.html

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
author_email='david.fischer@helmholtz-muenchen.de, diffxpy@frhoelzlwimmer.de'
66
description="Fast and scalable differential expression analysis on single-cell RNA-seq data"
77

8-
with open("README.md", "r") as fh:
8+
with open("README.rst", "r") as fh:
99
long_description = fh.read()
1010

1111
setup(

0 commit comments

Comments
 (0)