Skip to main content

vima

Variational inference-based microniche analysis is a method for conducting case-control analysis on multi-sample spatial molecular datasets. vima can be applied to any spatially resolved molecular technology, is well powered even at the modest sample sizes typical of research cohorts, and avoids traditional, parameter-intensive preprocessing steps such as cell segmentation or clustering of cells into discrete cell types. It works by treating each spatial sample as an image and using a variational autoencoder to extract numerical "fingerprints" from small tissue patches that capture their biological content. It uses these fingerprints to define a large number of "microniches" – small, potentially overlapping groups of tissue patches with highly similar biology that span multiple samples. It then uses rigorous permutation testing to identify microniches whose abundance correlates significantly with case-control status after accounting for multiple testing.

installation

vima can be installed via pip as follows:

pip install vima-spatial

Note that vima requires pytorch and harmonypy. These should install automatically through pip, but if you have trouble, try installing them first, verifying that they work, and then installing vima.

demo

To get started with an example analysis on a toy spatial transcriptomics dataset, take a look at our brief demo. You can see a completed read-only version or run an interactive version yourself on a Google Colab GPU (though this requires Colab Pro due to insufficient memory provided on the free tier.)

To see how to apply vima to a stain-based modality like CODEX, immunohistochemistry, or immunofluorescence, look at our immunofluorescence demo.

citation

If you use vima, please cite:

Y. Reshef, et al. Powerful and accurate case-control analysis of spatial molecular data. bioRxiv (In press at Nature Methods). https://doi.org/10.1101/2025.02.07.637149v1.

Metadata

Release files for vima-spatial 0.2.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vima-spatial 0.2.12
File Size Uploaded
vima_spatial-0.2.12.tar.gz 75.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for vima-spatial 0.2.12
File Interpreter ABI Platform
vima_spatial-0.2.12-py3-none-any.whl Python 3 none any Details

Total release size: 154.2 kB

Release files / vima_spatial-0.2.12.tar.gz

Download URL vima_spatial-0.2.12.tar.gz
Size 75.5 kB
Tags Source
SHA-256 checksum
How to use checksums
f475605736cb43326a3349baddcfc5591958d278e188370e5d6e65e77fbba662
BLAKE2b-256 checksum
How to use checksums
a66734af0ae62d062362506af1a7bceccc06d0eb8b07500d2a8c7cc28a67b7f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4

Release files / vima_spatial-0.2.12-py3-none-any.whl

Download URL vima_spatial-0.2.12-py3-none-any.whl
Size 78.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b720d5625b3c49122cba050e8e6cfbb06dc511dc4358a44b549387daa362f108
BLAKE2b-256 checksum
How to use checksums
2e5fa0920a4b869225d512b38e7e7bbd53c24f2e59391e700152d59cc7cea004
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.14.4
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page