Skip to main content

A Python implementation of the M3Drop single-cell RNA-seq analysis tool.

Project description

M3DropPy

A Python implementation of the M3Drop single-cell RNA-seq analysis tool, originally developed as an R package.

About

M3DropPy is a Python conversion of the popular M3Drop R package for dropout-based feature selection in single-cell RNA sequencing data. This package provides powerful methods for identifying highly variable and differentially expressed genes by leveraging the high frequency of dropout events (zero expression values) that are characteristic of single-cell RNA-seq data.

Background

Single-cell RNA sequencing often results in a large number of dropouts (genes with zero expression in particular cells) due to the technical challenges of reverse-transcribing and amplifying small quantities of RNA from individual cells. M3Drop takes advantage of this characteristic by modeling the relationship between dropout rate and mean expression using the Michaelis-Menten equation:

P_i = 1 - S_i/(S_i + K)

Where:

  • P_i is the proportion of cells where gene i drops out
  • S_i is the mean expression of gene i
  • K is the Michaelis constant

Key Features

M3Drop Method

  • Michaelis-Menten Modeling: Models dropout rates using enzyme kinetics principles
  • Feature Selection: Identifies differentially expressed genes by detecting outliers from the fitted curve
  • Optimized for Smart-seq2: Works best with full-transcript protocols without UMIs

DANB (Depth-Adjusted Negative Binomial) Method

  • UMI Compatibility: Specifically designed for UMI-tagged data (10X Chromium, etc.)
  • Depth Adjustment: Accounts for sequencing depth variations across cells
  • Negative Binomial Modeling: Models count data with appropriate variance structure

Additional Methods

  • Brennecke Method: Implementation of highly variable gene detection
  • Consensus Feature Selection: Combines multiple feature selection approaches
  • Pearson Residuals: Alternative normalization for UMI data

Installation

You can install M3DropPy using pip:

pip install M3Drop

Imports

You can import specific functions from different modules:

from m3Drop.basics import your_function_name
from m3Drop.M3D_Imputation import another_function

Usage

from m3Drop.basics import M3DropConvertData, M3DropFeatureSelection
from m3Drop.NB_UMI import NBumiFitModel, NBumiFeatureSelectionCombinedDrop, NBumiPearsonResiduals

# Load your single-cell expression data
# counts should be a genes x cells matrix

# For non-UMI data (Smart-seq2, etc.)
# Convert and normalize data
norm_data = M3DropConvertData(counts, is_counts=True)

# Perform M3Drop feature selection
selected_genes = M3DropFeatureSelection(norm_data, mt_method="fdr", mt_threshold=0.01)

# For UMI data (10X Chromium, etc.)
# Fit DANB model
danb_fit = NBumiFitModel(counts)

# Perform dropout-based feature selection
selected_genes = NBumiFeatureSelectionCombinedDrop(danb_fit, method="fdr", qval_thres=0.01)

# Calculate Pearson residuals for normalization
pearson_residuals = NBumiPearsonResiduals(counts, danb_fit)

When to Use Each Method

  • M3Drop: Use for Smart-seq2 and other full-transcript protocols without UMIs
  • DANB/NBumi: Use for UMI-tagged data like 10X Chromium
  • Consensus: Use when you want to combine multiple feature selection approaches

Original R Package

This Python implementation is based on the M3Drop R package developed by Tallulah Andrews and converted to Python by Anthony Son and Pragalvha Sharma.

Citation

If you use M3DropPy in your research, please cite the original M3Drop paper:

  • Andrews, T.S. and Hemberg, M. (2019). M3Drop: Dropout-based feature selection for scRNASeq. Bioinformatics, 35(16), 2865-2867.

Project details


Release history Release notifications | RSS feed

This version

0.4.5

Download files

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

Source Distribution

m3drop-0.4.5.tar.gz (20.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

m3drop-0.4.5-py3-none-any.whl (28.7 kB view details)

Uploaded Python 3

File details

Details for the file m3drop-0.4.5.tar.gz.

File metadata

  • Download URL: m3drop-0.4.5.tar.gz
  • Upload date:
  • Size: 20.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for m3drop-0.4.5.tar.gz
Algorithm Hash digest
SHA256 69cb66babdbd27db859cde380deb2bb5952171ecf083a9f97a7d08fa11b215c6
MD5 d091af327e699d80e96efa0985a11d21
BLAKE2b-256 9040fa8915aa2e42c67ffa8920837a973e888225b99e90c894fc6a91c71df830

See more details on using hashes here.

File details

Details for the file m3drop-0.4.5-py3-none-any.whl.

File metadata

  • Download URL: m3drop-0.4.5-py3-none-any.whl
  • Upload date:
  • Size: 28.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for m3drop-0.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 169301d088e2adbd98a83cbb0761b11bc0ffb670ce91f345534c1d09b57bd23b
MD5 e6f1e57ab05af94684e89aacc4c6ed6e
BLAKE2b-256 9f70144b2528b90861c15d02e5295d6dbc8a99204001dc33cd51c4f22645f345

See more details on using hashes here.

Supported by

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