Skip to main content

Identification of spatial homogeneous regions with concordex

Project description

concordex 1.0.2

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 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['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-1.0.2.tar.gz (9.9 kB view details)

Uploaded Source

Built Distribution

concordex-1.0.2-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: concordex-1.0.2.tar.gz
  • Upload date:
  • Size: 9.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for concordex-1.0.2.tar.gz
Algorithm Hash digest
SHA256 7b800bba39337e59341d7bfcbb66cd16d85e23009874f700e76f28db9eadc877
MD5 723dbf93d635a67aaea50a1d93cc5d62
BLAKE2b-256 4e2b2955c8cb775aec661fa586847b20fac2c74938785af721179ce1cd18570e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: concordex-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for concordex-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e08f0cea991213423e7d59a80e5888a6f8bd8d2e1b58252934952b062ecddf87
MD5 5d90ad08cb1b6a1a1bfde7789a9377cf
BLAKE2b-256 172efb20a8438b2fbc05dc094599f144d45396b49956087b2619f71aeb3fc1f1

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