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 versions 3.9 up to 3.10.

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.

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-1.6.3.tar.gz (84.9 kB view details)

Uploaded Source

Built Distribution

sdeper-1.6.3-py3-none-any.whl (89.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sdeper-1.6.3.tar.gz
  • Upload date:
  • Size: 84.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for sdeper-1.6.3.tar.gz
Algorithm Hash digest
SHA256 2b77042525519a1de5c07956e562fe2f0173e411a921826c4ab6b6ca1f5d6e10
MD5 620c8384cd8715a80815f70dd9cb63d4
BLAKE2b-256 92bfacdb20f4fdd212df69559fd09aa2281c6dbae819855c519dfc8b8575433f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sdeper-1.6.3-py3-none-any.whl
  • Upload date:
  • Size: 89.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for sdeper-1.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 da70da569ce5483a09d6ed4453cd352c44c093837eba0679219d32ab6579706d
MD5 bfa375b6fcae0df6fb4ded6bec33e60f
BLAKE2b-256 1cb5fa5b6d71448ec39f3738a11d919aa571a5f2cc8f72c91b715331107ef11f

See more details on using hashes here.

Supported by

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