Skip to main content

yomix: an interactive tool to explore low dimensional embeddings of omics data

Project description

Yomix logo

codestyle

LATEST RELEASE: see https://pypi.org/project/yomix/

DOCUMENTATION: https://perrin-isir.github.io/yomix/

Yomix is an interactive tool to explore low dimensional embeddings of omics data.

As illustrated in the GIF below, users can explore embeddings—typically generated using dimensionality reduction techniques such as UMAP, t-SNE, TriMap, or VAEs. Within these visualizations, users can identify clusters of interest and use a lasso tool to define specific subsets. Yomix can then compute gene signatures for these subsets almost instantaneously. For instance, it can identify gene signatures that best distinguish subset A from the rest of the data, differentiate subset A from subset B, or find genes whose expression levels are most strongly correlated with a user-defined direction within subset A.

alt text

INSTALL

In a python virtual environment, do:

pip install yomix

Then try the tool with:

yomix --example

To use it on your own files:

yomix yourfile.h5ad

where yourfile.h5ad is an anndata object saved in h5ad format (see anndata - Annotated data), with at least one .obsm field of dimension 2 or more (the low dimensional embedding).

When there are many samples in the dataset, the --subsampling option can be passed to improve reactiveness:

yomix --subsampling N yourfile.h5ad

It randomly subsamples the dataset to a maximum number of N samples. For example:

yomix --subsampling 5000 yourfile.h5ad
Other option: INSTALL FROM SOURCE

git clone https://github.com/perrin-isir/yomix.git

We recommand to create a python environment with micromamba, but any python package manager can be used instead.

cd yomix

micromamba create --name yomixenv --file environment.yaml

micromamba activate yomixenv

pip install -e .

Then try the tool with:

yomix yomix/example/pbmc.h5ad

The input file must be an anndata object saved in h5ad format (see anndata - Annotated data), with at least one .obsm field of dimension 2 or more.

Using Seurat objects with Yomix

You can use Seurat objects by converting them to .h5ad format in R:

Load required libraries:

library(rhdf5)
library(dplyr)
library(patchwork)
library(SeuratDisk)
library(Seurat)
library(SeuratData)

Load the object:

my_file <- readRDS("path.rds")

If it is a SingleCellExperiment object, convert to Seurat:

if (inherits(my_file, "SingleCellExperiment")) {
  my_file <- as.Seurat(my_file)
}

Save as H5Seurat:

SaveH5Seurat(my_file, filename = "filename.h5seurat")

Convert to .h5ad:

Convert("filename.h5seurat", dest = "h5ad", output.path = "/.h5ad")

List of contributors

Nicolas Perrin-Gilbert

Joshua Waterfall

Pierre Fumeron

Nisma Amjad

Jason Z. Kim

Erkan Narmanli

Christopher R. Myers

James P. Sethna

Jérôme Contant

Thomas Fuks

Julien Vibert

Silvia Tulli

Philippe Martin

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

yomix-1.6.1.tar.gz (5.4 MB view details)

Uploaded Source

Built Distribution

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

yomix-1.6.1-py3-none-any.whl (5.7 MB view details)

Uploaded Python 3

File details

Details for the file yomix-1.6.1.tar.gz.

File metadata

  • Download URL: yomix-1.6.1.tar.gz
  • Upload date:
  • Size: 5.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for yomix-1.6.1.tar.gz
Algorithm Hash digest
SHA256 aec4e604478aeb726223ee65a2c11ac82874b004b381dfe35dc9a09517454a5d
MD5 fccfabb0bf7e864c83ed5deab06c2c67
BLAKE2b-256 eb1360c4bb890d5bcd77ce09facdab86b3709b20a7e020a5d1094a7578dc919b

See more details on using hashes here.

File details

Details for the file yomix-1.6.1-py3-none-any.whl.

File metadata

  • Download URL: yomix-1.6.1-py3-none-any.whl
  • Upload date:
  • Size: 5.7 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for yomix-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dc673f7b54d1725e2bf3a90bb78c9155dba9321dc2946e429fda10da7934ec92
MD5 32f6a2d1185deda86b4e5a63244c9387
BLAKE2b-256 2e66113bca03157f42f56ecd783aa8d65a3ccf2af1b0add00a65b03dc89b49d7

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