Skip to main content

Spatial Deconvolution method with Platform Effect Removal

Project description

SDePER

OS PyPI - Python Version GitHub release (latest by date) PyPI Conda Version Docker Image Version (latest by date) Read the Docs (version) DOI

SDePER (Spatial Deconvolution method with Platform Effect Removal) is a hybrid machine learning and regression method to deconvolve Spatial barcoding-based transcriptomic data using reference single-cell RNA sequencing data, considering platform effects removal, sparsity of cell types per capture spot and across-spots spatial correlation in cell type compositions. SDePER is also able to impute cell type compositions and gene expression at unmeasured locations in a tissue map with enhanced resolution.

Quick Start

SDePER currently supports only Linux operating systems such as Ubuntu, and is compatible with Python 3.9.x and 3.10.x releases (3.11+ not yet supported).

SDePER can be installed via conda

conda create -n sdeper-env -c bioconda -c conda-forge python=3.9.12 sdeper

or pip

conda create -n sdeper-env python=3.9.12
conda activate sdeper-env
pip install sdeper

SDePER supports an out-of-the-box feature, meaning that users only need to provide the required four input files for cell type deconvolution. The package manages all aspects of file reading, preprocessing, cell type-specific marker gene identification, and more internally. The required files are:

  1. raw nUMI counts of spatial transcriptomics data (spots × genes): spatial.csv
  2. raw nUMI counts of reference scRNA-seq data (cells × genes): scrna_ref.csv
  3. cell type annotations for all cells in scRNA-seq data (cells × 1): scrna_anno.csv
  4. adjacency matrix of spots in spatial transcriptomics data (spots × spots; optional): adjacency.csv

To start cell type deconvolution using all default settings by running

runDeconvolution -q spatial.csv -r scrna_ref.csv -c scrna_anno.csv -a adjacency.csv

Homepage: https://az7jh2.github.io/SDePER/.

Full Documentation for SDePER is available here.

Example data and Analysis using SDePER are summarized in this page. All related materials can be found in the Analysis repository.

Citation

If you use SDePER, please cite:

Yunqing Liu, Ningshan Li, Ji Qi et al. SDePER: a hybrid machine learning and regression method for cell-type deconvolution of spatial barcoding-based transcriptomic data. Genome Biology 25, 271 (2024). https://doi.org/10.1186/s13059-024-03416-2

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

sdeper-2.0.1.tar.gz (93.0 kB view details)

Uploaded Source

Built Distribution

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

sdeper-2.0.1-py3-none-any.whl (97.9 kB view details)

Uploaded Python 3

File details

Details for the file sdeper-2.0.1.tar.gz.

File metadata

  • Download URL: sdeper-2.0.1.tar.gz
  • Upload date:
  • Size: 93.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sdeper-2.0.1.tar.gz
Algorithm Hash digest
SHA256 799bf425ac4e4bbde200a19033d44599d120d7a77994e3ff7dc0743fe84b94b6
MD5 b7d15d65b25a9634554e49b7680335cd
BLAKE2b-256 92b08194efaece04916c94fecda1bedd3f0b5cb7efe128d9214c01c51d29cea6

See more details on using hashes here.

Provenance

The following attestation bundles were made for sdeper-2.0.1.tar.gz:

Publisher: publish-to-pypi.yml on az7jh2/SDePER

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sdeper-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: sdeper-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 97.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sdeper-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72dbdc03bb31a159a5417041a15f2ce361411a9c5c26af85e3fc0e56645cba94
MD5 4ac6a2b3221d4880e578016e67705fd2
BLAKE2b-256 c962aed3ae28ccbebaf1cdc78e9ddc1d9193c16cda3282c19644c3d0b9e77526

See more details on using hashes here.

Provenance

The following attestation bundles were made for sdeper-2.0.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on az7jh2/SDePER

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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