Skip to content

Commit 1a539f5

Browse files
committed
update pypi readme
1 parent 6a41eaa commit 1a539f5

1 file changed

Lines changed: 44 additions & 18 deletions

File tree

pypi.rst

Lines changed: 44 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
|PyPI| |PyPIDownloads| |travis|
1+
|PyPI| |PyPIDownloads| |CI|
22

33
scVelo - RNA velocity generalized through dynamical modeling
44
============================================================
@@ -7,37 +7,54 @@ scVelo - RNA velocity generalized through dynamical modeling
77
:width: 300px
88
:align: left
99

10-
**scVelo** is a scalable toolkit for RNA velocity analysis in single cells.
11-
The methods are based on our preprint
12-
`Bergen et al. (2019) <https://doi.org/10.1101/820936>`_.
10+
**scVelo** is a scalable toolkit for RNA velocity analysis in single cells, based on
11+
`Bergen et al. (Nature Biotech, 2020) <https://doi.org/10.1038/s41587-020-0591-3>`_.
1312

14-
RNA velocity enables the recovery of directed dynamic information by leveraging splicing information.
15-
scVelo generalizes the concept of RNA velocity (`La Manno et al., 2018 <https://doi.org/10.1038/s41586-018-0414-6>`_)
13+
RNA velocity enables the recovery of directed dynamic information by leveraging splicing kinetics.
14+
scVelo generalizes the concept of RNA velocity
15+
(`La Manno et al., Nature, 2018 <https://doi.org/10.1038/s41586-018-0414-6>`_)
1616
by relaxing previously made assumptions with a stochastic and a dynamical model that solves the full
1717
transcriptional dynamics. It thereby adapts RNA velocity to widely varying specifications such as non-stationary populations.
1818

1919
scVelo is compatible with scanpy_ and hosts efficient implementations of all RNA velocity models.
2020

21-
See `<https://scvelo.org>`_ for documentation and tutorials.
22-
2321
scVelo's key applications
24-
-------------------------
22+
^^^^^^^^^^^^^^^^^^^^^^^^^
2523
- estimate RNA velocity to study cellular dynamics.
2624
- identify putative driver genes and regimes of regulatory changes.
2725
- infer a latent time to reconstruct the temporal sequence of transcriptomic events.
2826
- estimate reaction rates of transcription, splicing and degradation.
2927
- use statistical tests, e.g., to detect different kinetics regimes.
3028

29+
scVelo has, for instance, recently been used to study immune response in COVID-19
30+
patients and dynamic processes in human lung regeneration. Find out more in this list of
31+
`application examples <https://scholar.google.com/scholar?cites=18195185735875895912>`_.
32+
33+
Latest news
34+
^^^^^^^^^^^
35+
- Feb/2021: scVelo goes multi-core
36+
- Dec/2020: Cover of `Nature Biotechnology <https://www.nature.com/nbt/volumes/38>`_
37+
- Nov/2020: Talk at `Single Cell Biology <https://coursesandconferences.wellcomegenomecampus.org/our-events/single-cell-biology-2020/>`_
38+
- Oct/2020: `Helmholtz Best Paper Award <https://twitter.com/ICBmunich/status/1318611467722199041>`_
39+
- Oct/2020: Map cell fates with `CellRank <https://cellrank.org>`_
40+
- Sep/2020: Talk at `Single Cell Omics <https://twitter.com/fabian_theis/status/1305621028056465412>`_
41+
- Aug/2020: `scVelo out in Nature Biotech <https://www.helmholtz-muenchen.de/en/aktuelles/latest-news/press-information-news/article/48658/index.html>`_
42+
3143
Reference
32-
---------
33-
Bergen et al. (2019), *Generalizing RNA velocity to transient cell states through dynamical modeling*,
34-
`biorxiv <https://doi.org/10.1101/820936>`_.
44+
^^^^^^^^^
45+
Bergen *et al.* (2020), Generalizing RNA velocity to transient cell states through dynamical modeling,
46+
`Nature Biotech <https://doi.org/10.1038/s41587-020-0591-3>`_.
47+
|dim|
3548

3649
Support
37-
-------
38-
Feel free to submit an `issue <https://github.com/theislab/scvelo/issues/new/choose>`_
39-
or send us an `email <mailto:mail@scvelo.org>`_.
50+
^^^^^^^
51+
Found a bug or would like to see a feature implemented? Feel free to submit an
52+
`issue <https://github.com/theislab/scvelo/issues/new/choose>`_.
53+
Have a question or would like to start a new discussion? Head over to
54+
`GitHub discussions <https://github.com/theislab/scvelo/discussions>`_.
55+
In either case, you can also always send us an `email <mailto:mail@scvelo.org>`_.
4056
Your help to improve scVelo is highly appreciated.
57+
For further information visit `scvelo.org <https://scvelo.org>`_.
4158

4259

4360
.. |PyPI| image:: https://img.shields.io/pypi/v/scvelo.svg
@@ -49,7 +66,16 @@ Your help to improve scVelo is highly appreciated.
4966
.. |Docs| image:: https://readthedocs.org/projects/scvelo/badge/?version=latest
5067
:target: https://scvelo.readthedocs.io
5168

52-
.. |travis| image:: https://travis-ci.org/theislab/scvelo.svg?branch=master
53-
:target: https://travis-ci.org/theislab/scvelo
69+
.. |CI| image:: https://img.shields.io/github/workflow/status/theislab/scvelo/CI/master
70+
:target: https://github.com/theislab/scvelo/actions?query=workflow%3ACI
71+
72+
.. _scanpy: https://scanpy.readthedocs.io
73+
74+
.. |br| raw:: html
75+
76+
<br/>
77+
78+
.. |dim| raw:: html
5479

55-
.. _scanpy: https://scanpy.readthedocs.io
80+
<span class="__dimensions_badge_embed__" data-id="pub.1129830274" data-style="small_rectangle"></span>
81+
<script async src="https://badge.dimensions.ai/badge.js" charset="utf-8"></script>

0 commit comments

Comments
 (0)