Skip to main content

An advanced gene set scoring package for single-cell RNA sequencing data with GPU acceleration

Project description

Gene Scoring Package

This is a Python package implementing a novel gene set scoring methodology for single-cell RNA sequencing data analysis. It builds upon and extends techniques from widely used single-cell analysis toolkits such as Seurat and Scanpy, introducing several key improvements for more accurate gene set scoring.

alt text

Key Features

  1. Weighted Gene Contributions

    • Each gene in the evaluated module is assigned an appropriate weight based on its correlation with the phenotype of interest
    • Weights can be normalized to sum to 1 (optional)
  2. Individualized Background Selection

    • Background genes are selected independently for each gene of interest
    • Control features are selected from the same expression bin in the histogram
    • Background can be based on control sample, entire dataset, or a selected pool of genes
  3. Variance-scaled Gene Contribution

    • Individual gene contributions are scaled by their variance under examined conditions
    • Helps account for gene expression variability in different conditions
  4. Optimized Computation

    • GPU-accelerated score calculation for improved performance
    • Support for sparse matrices and chunked processing for large datasets
    • Efficient background gene selection algorithm

Installation

Basic Installation

pip install gene_scoring

Installation with GPU Support

pip install gene_scoring[gpu]

Mathematical Foundation

The scoring methodology is defined by the following formula:

S_c = Σ (w_l / (σ_c,l + ε)) * (X_c,l - X̄_l,control)

Where:

  • n: number of genes in the gene list
  • w_l: weight for gene l
  • X_c,l: mean expression value of gene l in condition c
  • X̄_l,control: average expression of control genes in the background
  • σ_c,l: standard deviation of gene expression in condition c
  • ε: small constant to avoid division by zero

Usage

from gene_scoring import GeneScorer

# Initialize the scorer
scorer = GeneScorer(
    normalize_weights=True,  # Normalize weights to sum to 1
    abs_diff=False,         # Use signed difference (not absolute)
    weighted=True           # Use weighted scoring
)

# Calculate scores
scores = scorer.calculate_scores(
    expression_matrix,    # Gene expression matrix (genes x cells)
    gene_list,           # List of genes to score
    weights=gene_weights  # Optional weights for each gene
)

Parameters

The main parameters for score calculation include:

  • normalize_weights: If True, weights are normalized to sum to 1
  • abs_diff: If True, use absolute difference between expression and background
  • weighted: If True, use weighted scoring (otherwise all weights = 1)
  • ctrl_size: Number of control genes to use per target gene
  • gpu: Whether to use GPU acceleration
  • chunk_size: Size of chunks for processing large datasets
  • random_state: Random seed for reproducibility

For detailed parameter descriptions and additional options, see the function documentation.

Requirements

  • Python ≥ 3.7
  • NumPy ≥ 1.19.0
  • Pandas ≥ 1.0.0
  • SciPy ≥ 1.5.0
  • CuPy ≥ 9.0.0 (optional, for GPU support)

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

gene_scoring-0.1.2.tar.gz (390.8 kB view details)

Uploaded Source

Built Distribution

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

gene_scoring-0.1.2-py3-none-any.whl (3.0 kB view details)

Uploaded Python 3

File details

Details for the file gene_scoring-0.1.2.tar.gz.

File metadata

  • Download URL: gene_scoring-0.1.2.tar.gz
  • Upload date:
  • Size: 390.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for gene_scoring-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b8233e25e9097e881f7214095457a1c351c110f8900b67ee93a63715a23206f6
MD5 bbd050761d7caf3ec5732c245bdfbbbb
BLAKE2b-256 39582f8cd8867d008467bfed95a05fe14a8a63c8131a128d50ba0f27cae81063

See more details on using hashes here.

File details

Details for the file gene_scoring-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: gene_scoring-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.8

File hashes

Hashes for gene_scoring-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 a4d4f864727e1e140505e47175430c19b9a752f58bb0078d543217d27558599e
MD5 9a447418da74a87beb4466329e8f895a
BLAKE2b-256 30ce95b4eac77ec10208b885abb1c17b62b9cef0f4780857a470718e6ddea515

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