Skip to content

Commit

Permalink
Update docs (#1227)
Browse files Browse the repository at this point in the history
* Update overview figures

* Update `docs/index.rst`

- Add banner for proper citation
- Drop email support
- Add CR2 manuscript in "Getting Started with CellRank" section
- Update spelling
- Add direct links to publications.

* Update `README.rst`

- Add banner for citation
- Remove email support
- Update CR2 DOI to publication
  • Loading branch information
WeilerP authored Sep 27, 2024
1 parent b5e9933 commit 7fa8658
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 11 deletions.
10 changes: 5 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,13 @@ CellRank 2: Unified fate mapping in multiview single-cell data

**CellRank** is a modular framework to study cellular dynamics based on Markov state modeling of
multi-view single-cell data. See our `documentation`_, and the `CellRank 1`_ and `CellRank 2 manuscript`_ to learn more.
See `here <https://github.com/theislab/cellrank/blob/main/docs/about/cite.rst>`_ for how to properly cite our work.

.. important::
Please refer to :doc:`our citation guide <https://github.com/theislab/cellrank/blob/main/docs/about/cite.rst>` to cite our software correctly.

CellRank scales to large cell numbers, is fully compatible with the `scverse`_ ecosystem, and easy to use.
In the backend, it is powered by `pyGPCCA`_ (`Reuter et al. (2018)`_). Feel
free to open an `issue`_ or send us an `email`_ if you encounter a bug, need our help or just
want to make a comment/suggestion.
free to open an `issue`_ if you encounter a bug, need our help or just want to make a comment/suggestion.

CellRank's key applications
---------------------------
Expand Down Expand Up @@ -63,8 +64,7 @@ CellRank's key applications
.. _pyGPCCA: https://github.com/msmdev/pyGPCCA

.. _CellRank 1: https://www.nature.com/articles/s41592-021-01346-6
.. _CellRank 2 manuscript: https://doi.org/10.1101/2023.07.19.549685
.. _CellRank 2 manuscript: https://doi.org/10.1038/s41592-024-02303-9
.. _documentation: https://cellrank.org

.. _email: mailto:info@cellrank.org
.. _issue: https://github.com/theislab/cellrank/issues/new/choose
Binary file modified docs/_static/img/dark_mode_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_static/img/light_mode_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 10 additions & 6 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,21 @@ CellRank 2: Unified fate mapping in multiview single-cell data

**CellRank** :cite:`lange:22,weiler:24` is a modular framework to study cellular dynamics based on Markov state modeling of
multi-view single-cell data. See :doc:`about CellRank <about/index>` to learn more and :doc:`our citation guide <about/cite>` for guidance on
citing our work correctly. Also, read our `recent preprint <https://doi.org/10.1101/2023.07.19.549685>`_ to see the new CellRank 2 features in action.
citing our work correctly. Two peer-reviewed publications accompany our software:
- `CellRank for directed single-cell fate mapping <https://doi.org/10.1038/s41592-021-01346-6>`
- `CellRank 2: unified fate mapping in multiview single-cell data <https://doi.org/10.1038/s41592-024-02303-9>`

.. important::
Please refer to :doc:`our citation guide <about/cite>` to cite our software correctly.

CellRank scales to large cell numbers, is fully compatible with the `scverse`_ ecosystem, and is easy to use. In the
backend, it is powered by the `pyGPCCA package <https://github.com/msmdev/pyGPCCA>`_ :cite:`reuter:19,reuter:22`. Feel
free to open an `issue`_ or send us an `email <mailto:info@cellrank.org>`_ if you encounter a bug, need our help or
just want to make a comment/suggestion.
free to open an `issue`_ if you encounter a bug, need our help or just want to make a comment/suggestion.

.. important::
If you're moving from CellRank 1 to CellRank 2, check out :doc:`../about/version2`.

CellRank's Key Applications
CellRank's key applications
---------------------------
- Estimate differentiation direction based on a varied number of biological priors, including
:doc:`pseudotime <notebooks/tutorials/kernels/300_pseudotime>`,
Expand All @@ -37,10 +41,10 @@ CellRank's Key Applications
- Visualize and cluster :doc:`gene expression trends <notebooks/tutorials/estimators/800_gene_trends>`.
- ... and much more, check out our :doc:`API <api/index>`.

Getting Started with CellRank
Getting started with CellRank
-----------------------------
We have :doc:`notebooks/tutorials/index` to help you getting started. To see CellRank in action, explore our
manuscript :cite:`lange:22` in Nature Methods.
manuscripts :cite:`lange:22,weiler:24` in Nature Methods.

Contributing
------------
Expand Down

0 comments on commit 7fa8658

Please sign in to comment.