Skip to main content

Single-cell RNA Sequencing Analysis

Reason this release was yanked:

Obsolete

Project description

Metacells - Single-cell RNA Sequencing Analysis

Build Status 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).

Metacell Analysis

Naively, scRNA_seq data is a set of cell profiles, where for each one, for each gene, we get a count of the mRNA molecules that existed in the cell for that gene. This serves as an indicator of how “expressed” or “active” the gene is.

As in any real world technology, the raw data may suffer from technical artifacts (counting the molecules of two cells in one profile, counting the molecules from a ruptured cells, counting only the molecules from the cell nucleus, etc.). This requires pruning the raw data to exclude such artifacts.

The current technology scRNA-seq data is also very sparse (typically <<10% the RNA molecules are counted). This introduces large sampling variance on top of the original signal, which itself contains significant inherent biological noise.

Analyzing scRNA-seq data therefore requires processing the profiles in bulk. Classically, this has been done by directly clustering the cells using various methods.

In contrast, the metacell approach groups together profiles of the “same” biological state into groups of cells of the “same” biological state, with the minimal number of profiles needed for computing robust statistics (in particular, mean gene expression). Each such group is a single “metacell”.

By summing profiles of cells of the “same” state together, each metacell greatly reduces the sampling variance, and provides a more robust estimation of the transcription state. Note a metacell is not a cell type (multiple metacells may belong to the same “type”, or even have the “same” state, if the data sufficiently over-samples this state). Also, a metacell is not a parametric model of the cell state. It is merely a more robust description of some cell state.

The metacells should therefore be further analyzed as if they were cells, using additional methods to classify cell types, detect cell trajectories and/or lineage, build parametric models for cell behavior, etc. Using metacells as input for such analysis techniques should benefit both from the more robust, less noisy input; and also from the (~100-fold) reduction in the number of cells to analyze when dealing with large data (e.g. analyzing millions of individual cells).

Installation

In short: pip install metacells. If you do not have sudo privileges, you might need to pip install --user metacells. Note that metacells requires many “heavy” dependencies, most notably numpy, pandas, scipy, scanpy, which pip should automatically install for you.

Note that metacells only runs natively on Linux and MacOS. To run it on a Windows computer, you must activate Windows Subsystem for Linux and install metacells within it.

The metacells package contains extensions written in C++. The metacells distribution provides pre-compiled Python wheels for both Linux and MacOS, so installing it using pip should not require a C++ compilation step.

Note that for X86 CPUs, these pre-compiled wheels were built to use AVX2, and will not work on older CPUs which are limited to SSE. Also, these wheels will not make use of any newer instructions (such as AVX512), even if available. While these wheels may not the perfect match for the machine you are running on, they are expected to work well for most machines.

To see the native capabilities of your machine, you can grep flags /proc/cpuinfo | head -1 which will give you a long list of supported CPU features in an arbitrary order, which may include sse, avx2, avx512, etc. You can therefore simply grep avx2 /proc/cpuinfo | head -1 to test whether AVX2 is/not supported by your machine.

You can avoid installing the pre-compiled wheel by running pip install metacells --install-option='--native'. This will force pip to compile the C++ extensions locally on your machine, optimizing for its native capabilities, whatever these may be. However, this requires you to have a C++ compiler installed (either g++ or clang), and it will take much longer to complete the installation.

Vignettes

The generated documentation contains the following vignettes: Basic Metacells Vignette, Manual Analysis Vignette, and Seurat Analysis Vignette.

You can also access their very latest version in the Github repository.

References

Please cite the references appropriately in case they are used:

License (MIT)

Copyright © 2020, 2021 Weizmann Institute of Science

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

metacells-0.5.tar.gz (286.3 kB view details)

Uploaded Source

Built Distributions

metacells-0.5-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (1.4 MB view details)

Uploaded PyPymanylinux: glibc 2.12+ x86-64

metacells-0.5-pp37-pypy37_pp73-macosx_10_9_x86_64.whl (1.9 MB view details)

Uploaded PyPymacOS 10.9+ x86-64

metacells-0.5-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (20.5 MB view details)

Uploaded CPython 3.9manylinux: glibc 2.12+ x86-64

metacells-0.5-cp39-cp39-macosx_11_0_arm64.whl (2.1 MB view details)

Uploaded CPython 3.9macOS 11.0+ ARM64

metacells-0.5-cp39-cp39-macosx_10_9_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.9macOS 10.9+ x86-64

metacells-0.5-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (20.5 MB view details)

Uploaded CPython 3.8manylinux: glibc 2.12+ x86-64

metacells-0.5-cp38-cp38-macosx_11_0_arm64.whl (2.1 MB view details)

Uploaded CPython 3.8macOS 11.0+ ARM64

metacells-0.5-cp38-cp38-macosx_10_9_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.8macOS 10.9+ x86-64

metacells-0.5-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (19.0 MB view details)

Uploaded CPython 3.7mmanylinux: glibc 2.12+ x86-64

metacells-0.5-cp37-cp37m-macosx_10_9_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.7mmacOS 10.9+ x86-64

File details

Details for the file metacells-0.5.tar.gz.

File metadata

  • Download URL: metacells-0.5.tar.gz
  • Upload date:
  • Size: 286.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/56.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.5

File hashes

Hashes for metacells-0.5.tar.gz
Algorithm Hash digest
SHA256 a5402af7f8f02566206a6a9dfb40305519daa5fe51acfdc17444f240316d3c18
MD5 ee7abdd297c10e5301de3a912b62fcb1
BLAKE2b-256 3a35bd2af08027366a50772e2413fde712999b917905c818b6ca293461818d03

See more details on using hashes here.

File details

Details for the file metacells-0.5-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl.

File metadata

File hashes

Hashes for metacells-0.5-pp37-pypy37_pp73-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 2e81a0f838c7bca1cd4d316a32fdb26bd93c00bdbfb14fc33946ea5c567769da
MD5 1acf7c36abfd3dc6865c5d557b6a06f8
BLAKE2b-256 152debdd86d1cd3b3ef7eee485bf38dc8a40fcd2e491796852d28f251de6d295

See more details on using hashes here.

File details

Details for the file metacells-0.5-pp37-pypy37_pp73-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: metacells-0.5-pp37-pypy37_pp73-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 1.9 MB
  • Tags: PyPy, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/56.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.5

File hashes

Hashes for metacells-0.5-pp37-pypy37_pp73-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 8dfe2b2e332f11c79548ee3366e33ad4d917b4e9c603a6f8a3d948346e768021
MD5 461a07b9082973469d981f0b3e6f9ca9
BLAKE2b-256 24d9cd7126f34c45fc733c1ea589d5feec5bdb3e4ea0717db10d9c1452e008c4

See more details on using hashes here.

File details

Details for the file metacells-0.5-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl.

File metadata

File hashes

Hashes for metacells-0.5-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 85184f8ead5ee7e2d2e9d138aa42bc5f8f5e1d187860cb14ba3f79449166b547
MD5 007980304d906f94b5064a1cc1250f25
BLAKE2b-256 1569b79a4ff359d17fae92867f664a34ae166eb546b6ed0feb07cc06075d8b9a

See more details on using hashes here.

File details

Details for the file metacells-0.5-cp39-cp39-macosx_11_0_arm64.whl.

File metadata

  • Download URL: metacells-0.5-cp39-cp39-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: CPython 3.9, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/56.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.5

File hashes

Hashes for metacells-0.5-cp39-cp39-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 c41bfd1b58e3e0e7b046f692b3dc4256b3a1509d42b3bef329395b5f3e7af619
MD5 7ef364e9f835eab6a9c2881090b3ef11
BLAKE2b-256 0f64b8fdbaa8ecda67d0801741335e5d640bf0ddfdb0f5a07200af83a35e80aa

See more details on using hashes here.

File details

Details for the file metacells-0.5-cp39-cp39-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: metacells-0.5-cp39-cp39-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: CPython 3.9, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/56.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.5

File hashes

Hashes for metacells-0.5-cp39-cp39-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 e7b7191a4e0a1e272216a5ea4abcfb1d53486f07e974265045aae0608d460a64
MD5 5f83a15ee6b7caae595660c26090bdab
BLAKE2b-256 99372e6e018516b2570614ed86a2aacf1e8412987863b9718c8aa94560abd69b

See more details on using hashes here.

File details

Details for the file metacells-0.5-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl.

File metadata

File hashes

Hashes for metacells-0.5-cp38-cp38-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 b058e4d3e39a189d926558bcc8118350537946b67f8cfb2f02654ae3b9dd3dec
MD5 3a278c8169fc638338cbb59500e2e85c
BLAKE2b-256 2049c237177fba6f26c5a3f2697a06369c7997f1bc38ddc1c886a3d02028eb01

See more details on using hashes here.

File details

Details for the file metacells-0.5-cp38-cp38-macosx_11_0_arm64.whl.

File metadata

  • Download URL: metacells-0.5-cp38-cp38-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: CPython 3.8, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/56.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.5

File hashes

Hashes for metacells-0.5-cp38-cp38-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 303572f0d3452b8891724d8645f436276a8c8db3a7389752ede90ef88623a843
MD5 7c8390eecf099bfe66cbb437961186e6
BLAKE2b-256 a17d2eeef9dfa42fa8b04d729e53ca7f1f71828f3629dcaab408493f2329d8ff

See more details on using hashes here.

File details

Details for the file metacells-0.5-cp38-cp38-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: metacells-0.5-cp38-cp38-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: CPython 3.8, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/56.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.5

File hashes

Hashes for metacells-0.5-cp38-cp38-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 1b226237662491cb026568d839131ed3cc11e72c1456e7b28a5729b9dedf4cfb
MD5 d2f5d6e5197ba0b5d405be70619ad251
BLAKE2b-256 27f54597295502b71af8c7286b6ed0157f391803d504f0353b661d5e8f62590f

See more details on using hashes here.

File details

Details for the file metacells-0.5-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl.

File metadata

File hashes

Hashes for metacells-0.5-cp37-cp37m-manylinux_2_12_x86_64.manylinux2010_x86_64.whl
Algorithm Hash digest
SHA256 c16b0d01b1edea363a41216056933631219ac7e1567a509bde11ee7fc3760451
MD5 6a1065c74b3742b7f7901eeaec6cd648
BLAKE2b-256 49f215ad24fef9c1a242dddff3c5570534e873a94cd024085a8801e1ff62a92e

See more details on using hashes here.

File details

Details for the file metacells-0.5-cp37-cp37m-macosx_10_9_x86_64.whl.

File metadata

  • Download URL: metacells-0.5-cp37-cp37m-macosx_10_9_x86_64.whl
  • Upload date:
  • Size: 2.2 MB
  • Tags: CPython 3.7m, macOS 10.9+ x86-64
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/56.1.0 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.7.5

File hashes

Hashes for metacells-0.5-cp37-cp37m-macosx_10_9_x86_64.whl
Algorithm Hash digest
SHA256 2f435e264794accf80de777d5caee039d387dd5cf7cda18e42fa4f6b6df7379a
MD5 7de069ed7447b5f43ca5c60271c53169
BLAKE2b-256 682798776d3d8215de1a20d497af4fa2236878f9fc4fb9ea00e647b95ebe0256

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page