Skip to main content

covarying neighborhood analysis

Project description

cna

Covarying neighborhood analysis is a method for finding structure in- and conducting association analysis with multi-sample single-cell datasets. cna does not require a pre-specified transcriptional structure such as a clustering of the cells in the dataset. It aims instead to flexibly identify differences of all kinds between samples. cna is fast, does not require parameter tuning, produces measures of statistical significance for its association analyses, and allows for covariate correction.

cna is built on top of scanpy and offers a scanpy-like interface for ease of use.

If you prefer R, there is an R implementation maintained separately by Ilya Korsunsky. (Though the R implementation may occasionally lag behind this implementation as updates are made.)

installation

To use cna, you can either install it directly from the Python Package Index by running, e.g.,

pip install cna

or if you'd like to manipulate the source code you can clone this repository and add it to your PYTHONPATH.

demo

Take a look at our tutorial to see how to get started with a small synthetic data set.

talk

You can learn more about cna by watching our talk at the Broad Institute's Models, Inference, and Algorithms seminar, which is preceded by a primer by Dylan Kotliar on nearest-neighbor graphs.

notices

  • April 29, 2025: We have made substantial changes to the cna API and are releasing a new package version 0.2.0. The main changes are that i) cna no longer will cache the NAM, and ii) cna will no longer use the MultiAnnData structure and will instead only use the standard scanpy AnnData structure. Code built for prior versions will likely not work for this new version, but should be easily adaptible by following the new demo.
  • October 19, 2023: We have found a source of miscalibration in cna’s local association testing of individual neighborhoods that applies to unusual datasets, typically with limited sample size and very low complexity. This issue does not affect cna’s global test, which tests for aggregate association between single-cell profiles and a case-control phenotype; it only affects cna’s identification of which individual neighborhoods explain an aggregate association. The miscalibration appears mild on real datasets. However, in simulated datasets we observed miscalibration when i) the case-control phenotype was extremely highly correlated with the first principal component of the neighborhood abundance matrix, and ii) there were many neighborhoods lacking true associations to this phenotype. This issue has been fixed in cna version 0.1.6, which uses the full-rank rather than the rank-k* neighborhood abundance matrix to compute neighborhood coefficients. We re-ran the primary analyses from the index cna paper with this new version of cna and found that the results were broadly unchanged. Although cna found fewer FDR-significant neighborhoods in each dataset, it still found large numbers of neighborhoods corresponding to the key associated cell populations (albeit at FDR 10% rather than 5% for the dataset with the smallest sample size [N=12]). Additionally, the prior and updated neighborhood coefficients remain very similar (R>0.9 in all datasets). We did not modify CNA’s global test, which determines whether there is any association between the single cell profiles and the case-control phenotype, as that portion of the method is unaffected.
  • January 20, 2022: It has come to our attention that a bug introduced on July 16, 2021 caused cna to behave incorrectly for users with anndata version 0.7.2 or later, possibly resulting in false positive or false negative results. This bug was fixed in cna version 0.1.4. We strongly recommend that any users with anndata version 0.7.2 or later either re-clone cna or run pip install --upgrade cna and re-run all analyses that may have been affected.

citation

If you use cna, please cite

[Reshef, Rumker], et al., Co-varying neighborhood analysis identifies cell populations associated with phenotypes of interest from single-cell transcriptomics. [...] contributed equally

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

cna-0.2.4.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

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

cna-0.2.4-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file cna-0.2.4.tar.gz.

File metadata

  • Download URL: cna-0.2.4.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for cna-0.2.4.tar.gz
Algorithm Hash digest
SHA256 7ae95f35d597de6ccfd3be8353fa426a251f344925414af075dc2ac6a820c830
MD5 da3e52c2d698e7ea0c88b3c444187e4b
BLAKE2b-256 97bb4dff500f997009b810c519cb13954a4b34c74868e99c32fa999f1ded5542

See more details on using hashes here.

File details

Details for the file cna-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: cna-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for cna-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c9ea1b5330066b0a7e6cc3073bfe3aa70914ed7ddd4d7b13cb5aa09af7dee597
MD5 f7851969c85790250ad0fa6a3aa3d442
BLAKE2b-256 9d0155d4a1ff32ab73eef44651c8e11fca52f9e3f727a82388850843dd6d474a

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