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.2.3

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.2.3.tar.gz (78.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.2.3-py3-none-any.whl (74.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for m3drop-0.2.3.tar.gz
Algorithm Hash digest
SHA256 e379785a92d421a54da334f4c07cc6a9f46930959690f6be09fcdc288ec1a971
MD5 2310109b2b47c0f9c7f2f2d6cc5969ba
BLAKE2b-256 f328910d26ce1d9b9589e2f378c7a6e33595c1929347614db27b344712ee1f23

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for m3drop-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 2cc8eac8e5aa9628f8c9d2f343449885473f27c2b2e5f17588c1817ccda0bece
MD5 7408cc438a8ac214d4215ae80db0d010
BLAKE2b-256 bcd5c0ec4091146bb606a13814c2eeb83ad59630f9c0b2c87900e89a53c79ac4

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