Skip to main content

A package to easily use Vitessce to create interactive plots for single-cell data

Project description

Easy Vitessce

🪄 Magic in a single line of code!

Turn your static Scanpy and SpatialData plots into interactive Vitessce visualizations with Easy Vitessce for spatial and single-cell data just by adding the easy_vitessce package!

Supported Plots

  • UMAP
  • PCA
  • t-SNE
  • Spatial (Scanpy version)
  • Spatial (SpatialData version)
  • Violin
  • Dotplot
  • Heatmap

Installation

Install package using pip:

pip install 'easy_vitessce @ git+https://github.com/luoselena/easy_vitessce@main'

How to Use

Importing Easy Vitessce

from easy_vitessce import configure_plots

🪄 All interactive plots are enabled magically.

Note that Scanpy is also required to run the package: import scanpy as sc

Supported Functions and Parameters

embedding:

basis: Plot type. "umap", "pca", or "tsne".

color: gene, e.g. "CD79A".

color_map: color map. "viridis", "plasma", or "jet".

spatial (Scanpy ver.):

color: annotations of observations, e.g. "log1p_n_genes_by_counts".

color_map: color map. "viridis", "plasma", or "jet".

Spatial (SpatialData ver.)

spatialdata_filepath: filepath of spatialdata zarr file containing image data.

zip_filepath: filepath of zip folder.

render_images(): renders image.

  • element: image data location.

render_shapes(): renders shapes, e.g. spots.

  • element: element to be rendered, e.g. "cells".
  • color: gene.
  • color_map: color map. "viridis", "plasma", or "jet".

render_labels(): renders labels.

  • element: label data location.

show(): displays interactive plot.

violin:

markers: list of genes. groupby: observation grouping, e.g. "bulk_labels"

dotplot:

markers: list of genes, e.g. ['C1QA', 'PSAP', 'CD79A', 'CD79B', 'CST3', 'LYZ'].

groupby: observation grouping, e.g. "bulk_labels"

heatmap:

color_map: colormap. "viridis", "plasma", or "jet".

markers: list of genes.

groupby: observation grouping.

Deactivating Interactive Plots:

configure_plots(disable_plots = ["spatial", "violin"]

Reactivating Interactive Plots:

configure_plots(enable_plots = ["spatial", "violin"]

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

easy_vitessce-0.0.1.tar.gz (40.3 MB view details)

Uploaded Source

Built Distribution

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

easy_vitessce-0.0.1-py3-none-any.whl (40.1 MB view details)

Uploaded Python 3

File details

Details for the file easy_vitessce-0.0.1.tar.gz.

File metadata

  • Download URL: easy_vitessce-0.0.1.tar.gz
  • Upload date:
  • Size: 40.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for easy_vitessce-0.0.1.tar.gz
Algorithm Hash digest
SHA256 40532dcd93174a5aaf970a531b6acfdc6712931ba684845cbd0b244ce8a96c85
MD5 9bf99b357fe374e12ffcaaae9102092a
BLAKE2b-256 93ffe269e6b29104ec072399e8552b615219326ba3ca552701c94d18bc3aceff

See more details on using hashes here.

File details

Details for the file easy_vitessce-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: easy_vitessce-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 40.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.20

File hashes

Hashes for easy_vitessce-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 37f8f76379ada4b86da77140de2f2a87e630edb6d5d7ef92b438b26f6243c624
MD5 55aa2cf4591eaf5975a39115d93dd008
BLAKE2b-256 2cf69c9bfcdf9f1281890e57a24a7923c1848fa06725f1addf8804abc6f472a9

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