Skip to main content

Identification of spatial homogeneous regions with concordex

Project description

concordex 2.0.0

The goal of concordex is to identify spatial homogeneous regions (SHRs) as defined in the recent manuscript, “Identification of spatial homogenous regions in tissues with concordex”. Briefly, SHRs are are domains that are homogeneous with respect to cell type composition. concordex relies on the the k-nearest-neighbor (kNN) graph to representing similarities between cells and uses common clustering algorithms to identify SHRs.

Installation

concordex can be installed via pip

pip install concordex

.... and from Github

pip install git+https://github.com/pachterlab/concordex.git

Usage

After installing, concordex can be run as follows:

import scanpy as sc 
from concordex.tools import calculate_concordex

ad = sc.datasets.pbmc68k_reduced()

# Compute concordex with discrete labels
calculate_concordex(ad, 'louvain', n_neighbors=10)

# Neighborhood consolidation information is stored in `adata.obsm`
ad.obsm['X_nbc'][:3]

# The column names are stored in `adata.uns`
ad.uns['nbc_params']['nbc_colnames']

Citation

If you’d like to use the concordex package in your research, please cite our recent bioRxiv preprint:

Jackson, K.; Booeshaghi, A. S.; Gálvez-Merchán, Á.; Moses, L.; Chari, T.; Kim, A.; Pachter, L. Identification of spatial homogeneous regions in tissues with concordex. bioRxiv (Cold Spring Harbor Laboratory) 2023. https://doi.org/10.1101/2023.06.28.546949.

@article {Jackson2023.06.28.546949, 
    author = {Jackson, Kayla C. and Booeshaghi, A. Sina and G{'a}lvez-Merch{'a}n, {'A}ngel and Moses, Lambda and Chari, Tara and Kim, Alexandra and Pachter, Lior}, 
    title = {Identification of spatial homogeneous regions in tissues with concordex}, 
    year = {2024}, 
    doi = {10.1101/2023.06.28.546949}, 
    publisher = {Cold Spring Harbor Laboratory}, 
    URL = {<https://www.biorxiv.org/content/early/2024/07/18/2023.06.28.546949>},
    journal = {bioRxiv} 
}

Maintainer

Kayla Jackson

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

concordex-2.0.0.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

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

concordex-2.0.0-py3-none-any.whl (9.6 kB view details)

Uploaded Python 3

File details

Details for the file concordex-2.0.0.tar.gz.

File metadata

  • Download URL: concordex-2.0.0.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for concordex-2.0.0.tar.gz
Algorithm Hash digest
SHA256 2d3d15dfb912de70a8505c072c28b0c9f87102c9ea64a12174c3ed24c249446d
MD5 a6df66e202dfa8eec31670299e371d00
BLAKE2b-256 6a92a3929160b76ed5a3a14533fd7d169232d58565d34920cdd8f1ed3677b629

See more details on using hashes here.

File details

Details for the file concordex-2.0.0-py3-none-any.whl.

File metadata

  • Download URL: concordex-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 9.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.7

File hashes

Hashes for concordex-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bd07da12725b49c04933bcf9df853f0479e9dfed097404e5330f5f43c420b3d3
MD5 477e45e673be2c25f3bb6b4aaef62211
BLAKE2b-256 4d9fa7b7b4538199b1a5da902f50fdf49b8225908b01f1cc515cb8a2a14ec938

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