Skip to content

Commit

Permalink
Publish 0.9.4.
Browse files Browse the repository at this point in the history
  • Loading branch information
orenbenkiki committed Oct 24, 2023
1 parent 4662351 commit ed4f655
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 15 deletions.
22 changes: 13 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Metacells 0.9.4dev - Single-cell RNA Sequencing Analysis
========================================================
Metacells 0.9.4 - Single-cell RNA Sequencing Analysis
=====================================================

.. image:: https://readthedocs.org/projects/metacells/badge/?version=latest
:target: https://metacells.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status

The metacells package implements the improved metacell algorithm [1]_ for single-cell RNA sequencing (scRNA-seq) data
analysis within the `scipy <https://www.scipy.org/>`_ framework. The original metacell algorithm [2]_ was implemented in
R. The python package contains various algorithmic improvements and is scalable for larger data sets (millions of
cells).
analysis within the `scipy <https://www.scipy.org/>`_ framework, and projection algorithm based on it [2]_. The original
metacell algorithm [3]_ was implemented in R. The python package contains various algorithmic improvements and is
scalable for larger data sets (millions of cells).

Metacell Analysis
-----------------
Expand Down Expand Up @@ -61,9 +61,10 @@ Terminology and Results Format
of the result annotations. See below for the description of updated results (and how they differ from version 0.8). The
new format is meant to improve the usability of the system in downstream analysis pipelines. For convenience we also
list here the results of the new projection pipeline added in version 0.9.*. Versions 0.9.1 and 0.9.2 contain some bug
fixes. The latest version published 0.9.3 allows specifying target UMIs for the metacells, in addition to the target
size in cells, and adaptively tries to satisfy both. This should produce better-sized metacells "out of the box"
compared to the 0.9.[0-2] versions.
fixes. Version 0.9.3 allows specifying target UMIs for the metacells, in addition to the target size in cells, and
adaptively tries to satisfy both. This should produce better-sized metacells "out of the box" compared to the 0.9.[0-2]
versions. The latest published version, 0.9.4, contains minor bug fixes and updates for newer versions of dependency
packages.

If you have existing metacell data that was computed using version 0.8 (the current published version you will get
from using ``pip install metacells``, you can use the provided
Expand Down Expand Up @@ -456,7 +457,10 @@ Please cite the references appropriately in case they are used:
.. [1] Ben-Kiki, O., Bercovich, A., Lifshitz, A. et al. Metacell-2: a divide-and-conquer metacell algorithm for scalable
scRNA-seq analysis. Genome Biol 23, 100 (2022). https://doi.org/10.1186/s13059-022-02667-1
.. [2] Baran, Y., Bercovich, A., Sebe-Pedros, A. et al. MetaCell: analysis of single-cell RNA-seq data using K-nn graph
.. [2] Ben-Kiki, O., Bercovich, A., Lifshitz, A. et al. MCProj: metacell projection for interpretable and quantitative
use of transcriptional atlases. Genome Biol 24, 220 (2023). https://doi.org/10.1186/s13059-023-03069-7
.. [3] Baran, Y., Bercovich, A., Sebe-Pedros, A. et al. MetaCell: analysis of single-cell RNA-seq data using K-nn graph
partitions. Genome Biol 20, 206 (2019). `10.1186/s13059-019-1812-2 <https://doi.org/10.1186/s13059-019-1812-2>`_
License (MIT)
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -85,15 +85,15 @@

# General information about the project.
project = 'Metacells'
copyright = "2020,2021,2022 Weizmann Institute of Science"
copyright = "2020-2023 Weizmann Institute of Science"
author = "Oren Ben-Kiki"

# The version info for the project you're documenting, acts as replacement
# for |version| and |release|, also used in various other places throughout
# the built documents.
#
# The short X.Y version.
version = "0.9.4dev"
version = "0.9.4"
# The full version, including alpha/beta/rc tags.
release = version

Expand Down
4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Metacells 0.9.4dev
==================
Metacells 0.9.4
===============

.. toctree::
:titlesonly:
Expand Down
2 changes: 1 addition & 1 deletion metacells/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

__author__ = "Oren Ben-Kiki"
__email__ = "[email protected]"
__version__ = "0.9.4dev"
__version__ = "0.9.4"

if "sphinx" not in sys.argv[0]:
from .should_check_avx2 import SHOULD_CHECK_AVX2
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,5 +105,5 @@
tests_require=test_requirements,
extras_require={"dev": dev_requirements},
url="https://github.com/tanaylab/metacells.git",
version="0.9.4dev",
version="0.9.4",
)

0 comments on commit ed4f655

Please sign in to comment.