diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index c5a5f282..74cfbff5 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -14,5 +14,6 @@ jobs:
run: |
sudo apt-get update
sudo apt-get install -y pandoc
- - run: uv sync --extra docs --extra all
+ - run: uv sync --extra docs --extra notebook --extra all
+ - run: uv run marimo export html-wasm docs/notebooks/marimo-wasm.mo.py -o docs/_static/mo/marimo-wasm.mo.html --mode edit
- run: uv run make html
diff --git a/.github/workflows/test_widget.yml b/.github/workflows/test_widget.yml
index b8c0fe02..333be5cd 100644
--- a/.github/workflows/test_widget.yml
+++ b/.github/workflows/test_widget.yml
@@ -29,11 +29,11 @@ jobs:
- name: Install vitessce
run: uv sync --extra dev --extra all --extra notebook
- name: Export Jupyter notebook to HTML
- run: uv run jupyter nbconvert --to=html --execute docs/notebooks/widget_from_dict.ipynb
+ run: uv run jupyter nbconvert --to=html --execute docs/notebooks/__ipynb__/widget_from_dict.ipynb
- name: Export Marimo notebook to HTML
- run: uv run marimo export html docs/notebooks/marimo.py -o docs/notebooks/marimo.html
+ run: uv run marimo export html docs/notebooks/marimo.mo.py -o docs/notebooks/marimo.mo.html
- name: Export Marimo notebook to HTML-WASM
- run: uv run marimo export html-wasm docs/notebooks/marimo-wasm.py -o docs/notebooks/marimo-wasm.html --mode edit
+ run: uv run marimo export html-wasm docs/notebooks/marimo-wasm.mo.py -o docs/notebooks/marimo-wasm.mo.html --mode edit
- name: Check that widget renders in HTML output using Playwright
run: pnpm exec playwright test
working-directory: ./tests-widget
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 4e008044..7059a3a7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -11,7 +11,13 @@ tests/data/*
!tests/data/test.ome.tif
./notebooks/
docs/notebooks/data/
+docs/notebooks/data-cropped/
+docs/notebooks/kpmp-2024/
+docs/notebooks/segmentations/
+docs/notebooks/*.json
docs/notebooks/*.html
+docs/notebooks/*.ipynb
+docs/notebooks/*.zarr/
__pycache__/
.snakemake/
.coverage
@@ -19,6 +25,9 @@ demos/*/data/
demos/*/vitessce.local.json
demos/*/vitessce.remote.json
.pytest_cache/
+__marimo__/
+assets/
+docs/_static/mo/
# Compiled javascript
vitessce/static/
diff --git a/docs/_static/mo/.gitkeep b/docs/_static/mo/.gitkeep
new file mode 100644
index 00000000..e69de29b
diff --git a/docs/conf.py b/docs/conf.py
index d14b41ab..229933a5 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -3,6 +3,7 @@
import sys
import glob
from os.path import join
+import json
import vitessce
@@ -123,9 +124,39 @@ def find_source():
# -- Strip notebook output -------------------------------------------------
-for filename in glob.glob(join('notebooks', '*.ipynb'), recursive=True):
+for filename in glob.glob(join('notebooks', "__ipynb__", '*.ipynb'), recursive=True):
ntbk = nbclean.NotebookCleaner(filename)
ntbk.clear('stderr')
ntbk.clear('output')
ntbk.remove_cells(empty=True)
+ ntbk.remove_cells(search_text="import marimo as mo")
ntbk.save(filename)
+
+ # Add missing metadata, to enable the code to be interpreted as Python code
+ # for syntax highlighting when rendered by nbsphinx.
+ with open(filename, 'r') as f:
+ ntbk_json = json.load(f)
+ with open(filename, 'w') as f:
+ if len(ntbk_json['metadata']) == 0:
+ # If the metadata is empty, we add the default metadata.
+ # This is needed for nbsphinx to render the notebook correctly.
+ ntbk_json['metadata'] = {
+ "kernelspec": {
+ "display_name": "Python 3 (ipykernel)",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.10.14"
+ }
+ }
+ json.dump(ntbk_json, f, indent=2)
diff --git a/docs/data_examples.rst b/docs/data_examples.rst
index 4553453c..f39979a1 100644
--- a/docs/data_examples.rst
+++ b/docs/data_examples.rst
@@ -5,7 +5,7 @@ Data preparation examples
.. toctree::
:maxdepth: 2
- notebooks/data_export_s3
- notebooks/data_export_files
- notebooks/widget_brain_with_base_dir
- notebooks/widget_brain_h5ad
\ No newline at end of file
+ notebooks/__ipynb__/data_export_s3
+ notebooks/__ipynb__/data_export_files
+ notebooks/__ipynb__/widget_brain_with_base_dir
+ notebooks/__ipynb__/widget_brain_h5ad
\ No newline at end of file
diff --git a/docs/notebooks/__ipynb__/cellbrowser_to_vitessce_config_conversion.ipynb b/docs/notebooks/__ipynb__/cellbrowser_to_vitessce_config_conversion.ipynb
new file mode 100644
index 00000000..31abf63b
--- /dev/null
+++ b/docs/notebooks/__ipynb__/cellbrowser_to_vitessce_config_conversion.ipynb
@@ -0,0 +1,190 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "id": "MJUe",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "# Load UCSC Cell Browser project in Vitessce"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "vblA",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "This notebook shows you how to use the `convert_cell_browser_project_to_anndata` function, which allows you to take an existing project, published in https://cells.ucsc.edu/ and:\n",
+ "1. Convert it into the AnnData format that is supported by Vitessce\n",
+ "2. Save the AnnData object as a Zarr store\n",
+ "3. Configure Vitessce with the AnnData-Zarr store\n",
+ "4. Render a Vitessce widget based on the config (step 3) directly in the notebook.\n",
+ "\n",
+ "The dataset that you choose to convert needs to be a valid UCSC Cell Browser \"project\", accessible from https://cells.ucsc.edu/, with a configuration available in https://github.com/ucscGenomeBrowser/cellbrowser-confs\n",
+ "\n",
+ "The `convert_cell_browser_project_to_anndata` function takes the name of that project as an input. For example, to convert this project, https://cells.ucsc.edu/?ds=adultPancreas, you will neeed to pass `\"adultPancreas\"` as the project name."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "bkHC",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "import os\n",
+ "import json\n",
+ "from os.path import join\n",
+ "from vitessce import (\n",
+ " convert_cell_browser_project_to_anndata,\n",
+ " AnnDataWrapper,\n",
+ " VitessceConfig,\n",
+ ")\n",
+ "from vitessce.data_utils import VAR_CHUNK_SIZE"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "lEQa",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 1. Convert UCSC Cell Browser project to a format that is supported by Vitessce\n",
+ "#### Output:\n",
+ "An AnnData object"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "PKri",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "# Example run, coverting \"adultPancreas\" project:\n",
+ "adata = convert_cell_browser_project_to_anndata(project_name=\"adultPancreas\", keep_only_marker_genes=True)"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "Xref",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 2. Save the AnnData object as a Zarr store"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "SFPL",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "zarr_filepath = join(\"data\", \"out.adata.zarr\")\n",
+ "os.makedirs(os.path.dirname(zarr_filepath), exist_ok=True)\n",
+ "adata.write_zarr(zarr_filepath, chunks=[adata.shape[0], VAR_CHUNK_SIZE])"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "BYtC",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 3. Configure Vitessce with the AnnData-Zarr store"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "RGSE",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "anndata_wrapper_inst = AnnDataWrapper(\n",
+ " adata_path=zarr_filepath,\n",
+ " obs_feature_matrix_path=\"X\",\n",
+ " obs_embedding_paths=[\"obsm/X_tsne\"],\n",
+ " obs_embedding_names=[\"t-SNE\"],\n",
+ " obs_set_paths=[\"obs/cluster\", \"obs/age\"],\n",
+ " obs_set_names=[\"cluster\", \"age\"],\n",
+ ")\n",
+ "vc = VitessceConfig(schema_version=\"1.0.15\", name=\"Vitessce configuration for CellBrowser project adultPancreas\")\n",
+ "anndata_wrapper_inst.auto_view_config(vc)"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "Kclp",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 4. Render the Vitessce widget"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "emfo",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "vw = vc.widget()\n",
+ "vw"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Python 3 (ipykernel)",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.10.14"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
\ No newline at end of file
diff --git a/docs/notebooks/__ipynb__/config_to_python.ipynb b/docs/notebooks/__ipynb__/config_to_python.ipynb
new file mode 100644
index 00000000..084378cf
--- /dev/null
+++ b/docs/notebooks/__ipynb__/config_to_python.ipynb
@@ -0,0 +1,216 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "id": "Hbol",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "# Generate Python code to reconstruct a VitessceConfig instance"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "MJUe",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "from vitessce import VitessceConfig, VitessceChainableConfig, VitessceConfigDatasetFile"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "vblA",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "from example_configs import dries as dries_config"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "bkHC",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## Load a view config from a dict representation"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "lEQa",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "vc = VitessceConfig.from_dict(dries_config)"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "PKri",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## Print to JSON"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "Xref",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "import json\n",
+ "print(json.dumps(vc.to_dict(), indent=2))"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "SFPL",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## Print to Python\n",
+ "\n",
+ "The `vc.to_python` function generates formatted Python code which can be used to re-generate the `vc` instance."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "BYtC",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "imports, code = vc.to_python()"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "RGSE",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "The first value returned is a list of classes used by the code snippet."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "Kclp",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "imports"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "emfo",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "print(code)"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "Hstk",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "The second value is the code snippet. When evaluated, the result will be a new `VitessceConfig` instance."
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "nWHF",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## Evaluate the code and render a Vitessce widget"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "iLit",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "reconstructed_vc = eval(code)"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "ZHCJ",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "reconstructed_vc.widget()"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Python 3 (ipykernel)",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.10.14"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
\ No newline at end of file
diff --git a/docs/notebooks/__ipynb__/data_conversion.ipynb b/docs/notebooks/__ipynb__/data_conversion.ipynb
new file mode 100644
index 00000000..bb1c6f96
--- /dev/null
+++ b/docs/notebooks/__ipynb__/data_conversion.ipynb
@@ -0,0 +1,111 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "id": "Hbol",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "# Convert data manually"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "MJUe",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "When running the Vitessce widget, data is converted on-the-fly into formats that the Vitessce JavaScript component can render.\n",
+ "The converted data is stored in temporary files, preventing long-term use of the converted files.\n",
+ "\n",
+ "However, the data conversion utilities used by the widget are exposed so that their outputs can be saved to regular files.\n",
+ "This allows the files to be saved for future use with the Vitessce web application by serving the files locally or moving the files onto an object storage system such as AWS S3 (for long-term storage and data sharing).\n",
+ "\n",
+ "This notebook demonstrates how to save the processed outputs of the `AnnDataWrapper` and `SnapWrapper` classes."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "vblA",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "from vitessce import SnapWrapper\n",
+ "from os.path import join\n",
+ "from scipy.io import mmread\n",
+ "import pandas as pd\n",
+ "import numpy as np\n",
+ "import json"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "bkHC",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "mtx = mmread(join('data', 'snapatac', 'filtered_cell_by_bin.mtx'))\n",
+ "barcodes_df = pd.read_csv(join('data', 'snapatac', 'barcodes.txt'), header=None)\n",
+ "bins_df = pd.read_csv(join('data', 'snapatac', 'bins.txt'), header=None)\n",
+ "clusters_df = pd.read_csv(join('data', 'snapatac', 'umap_coords_clusters.csv'), index_col=0)"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "lEQa",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "zarr_filepath = join('data', 'snapatac', 'out.snap.multires.zarr')\n",
+ "\n",
+ "w = SnapWrapper(mtx, barcodes_df, bins_df, clusters_df)\n",
+ "\n",
+ "cells_json = w.create_cells_json()\n",
+ "cell_sets_json = w.create_cell_sets_json()\n",
+ "\n",
+ "with open(join('data', 'snapatac', 'out.cells.json'), 'w') as f:\n",
+ " json.dump(cells_json, f)\n",
+ "\n",
+ "with open(join('data', 'snapatac', 'out.cell-sets.json'), 'w') as f:\n",
+ " json.dump(cell_sets_json, f)\n",
+ "\n",
+ "\n",
+ "w.create_genomic_multivec_zarr(zarr_filepath)"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Python 3 (ipykernel)",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.10.14"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
\ No newline at end of file
diff --git a/docs/notebooks/__ipynb__/data_export_files.ipynb b/docs/notebooks/__ipynb__/data_export_files.ipynb
new file mode 100644
index 00000000..e5a282b2
--- /dev/null
+++ b/docs/notebooks/__ipynb__/data_export_files.ipynb
@@ -0,0 +1,276 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "id": "Hbol",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "# Export data to local files"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "MJUe",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 1. Import dependencies\n",
+ "\n",
+ "We need to import the classes and functions that we will be using from the corresponding packages."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "vblA",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "import os\n",
+ "import json\n",
+ "from urllib.parse import quote_plus\n",
+ "from os.path import join, isfile, isdir\n",
+ "from urllib.request import urlretrieve\n",
+ "from anndata import read_h5ad\n",
+ "import scanpy as sc\n",
+ "\n",
+ "from vitessce import (\n",
+ " VitessceWidget,\n",
+ " VitessceConfig,\n",
+ " Component as cm,\n",
+ " CoordinationType as ct,\n",
+ " AnnDataWrapper,\n",
+ ")\n",
+ "from vitessce.data_utils import (\n",
+ " optimize_adata,\n",
+ " VAR_CHUNK_SIZE,\n",
+ ")"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "bkHC",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 2. Download and process data\n",
+ "\n",
+ "For this example, we need to download a dataset from the COVID-19 Cell Atlas https://www.covid19cellatlas.org/index.healthy.html#habib17."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "lEQa",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "adata_filepath = join(\"data\", \"habib17.processed.h5ad\")\n",
+ "if not isfile(adata_filepath):\n",
+ " os.makedirs(\"data\", exist_ok=True)\n",
+ " urlretrieve('https://covid19.cog.sanger.ac.uk/habib17.processed.h5ad', adata_filepath)\n",
+ "\n",
+ "adata = read_h5ad(adata_filepath)\n",
+ "top_dispersion = adata.var[\"dispersions_norm\"][\n",
+ " sorted(\n",
+ " range(len(adata.var[\"dispersions_norm\"])),\n",
+ " key=lambda k: adata.var[\"dispersions_norm\"][k],\n",
+ " )[-51:][0]\n",
+ "]\n",
+ "adata.var[\"top_highly_variable\"] = (\n",
+ " adata.var[\"dispersions_norm\"] > top_dispersion\n",
+ ")"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "PKri",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "zarr_filepath = join('data', 'habib17.processed.zarr')\n",
+ "if not isdir(zarr_filepath):\n",
+ " adata_1 = optimize_adata(adata, obs_cols=['CellType'], obsm_keys=['X_umap'], var_cols=['top_highly_variable'], optimize_X=True)\n",
+ " adata_1.write_zarr(zarr_filepath, chunks=[adata_1.shape[0], VAR_CHUNK_SIZE])"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "Xref",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 3. Create the Vitessce configuration"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "SFPL",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "Set up the configuration by adding the views and datasets of interest."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "BYtC",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "vc = VitessceConfig(schema_version=\"1.0.15\", name='Habib et al', description='COVID-19 Healthy Donor Brain')\n",
+ "dataset = vc.add_dataset(name='Brain').add_object(AnnDataWrapper(\n",
+ " adata_path=zarr_filepath,\n",
+ " obs_embedding_paths=[\"obsm/X_umap\"],\n",
+ " obs_embedding_names=[\"UMAP\"],\n",
+ " obs_set_paths=[\"obs/CellType\"],\n",
+ " obs_set_names=[\"Cell Type\"],\n",
+ " obs_feature_matrix_path=\"X\",\n",
+ " feature_filter_path=\"var/top_highly_variable\"\n",
+ "))\n",
+ "scatterplot = vc.add_view(cm.SCATTERPLOT, dataset=dataset, mapping=\"X_umap\")\n",
+ "cell_sets = vc.add_view(cm.OBS_SETS, dataset=dataset)\n",
+ "genes = vc.add_view(cm.FEATURE_LIST, dataset=dataset)\n",
+ "heatmap = vc.add_view(cm.HEATMAP, dataset=dataset)\n",
+ "vc.layout((scatterplot | (cell_sets / genes)) / heatmap);"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "RGSE",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 4. Export files to a local directory\n",
+ "\n",
+ "The `.export(to='files')` method on the view config instance will export files to the specified directory `out_dir`. The `base_url` parameter is required so that the file URLs in the view config point to the location where you ultimately intend to serve the files."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "Kclp",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "config_dict = vc.export(to='files', base_url='http://localhost:3000', out_dir='./test')"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "emfo",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 5. Serve the files"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "Hstk",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "Now that the files have been saved to the `./test` directory, they can be served by any static web server.\n",
+ "\n",
+ "If you would like to serve the files locally, we recommend [http-server](https://github.com/http-party/http-server) which can be installed with NPM or Homebrew:\n",
+ "```sh\n",
+ "cd test\n",
+ "http-server ./ --cors -p 3000\n",
+ "```"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "nWHF",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 6. View on vitessce.io\n",
+ "\n",
+ "The returned view config dict can be converted to a URL, and if the files are served on the internet (rather than locally), this URL can be used to share the interactive visualizations with colleagues."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "iLit",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "vitessce_url = \"http://vitessce.io/?url=data:,\" + quote_plus(json.dumps(config_dict))\n",
+ "import webbrowser\n",
+ "webbrowser.open(vitessce_url)"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Python 3 (ipykernel)",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.10.14"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
\ No newline at end of file
diff --git a/docs/notebooks/__ipynb__/data_export_s3.ipynb b/docs/notebooks/__ipynb__/data_export_s3.ipynb
new file mode 100644
index 00000000..5ed073d9
--- /dev/null
+++ b/docs/notebooks/__ipynb__/data_export_s3.ipynb
@@ -0,0 +1,271 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "id": "Hbol",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "# Export data to AWS S3"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "MJUe",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 1. Import dependencies\n",
+ "\n",
+ "We need to import the classes and functions that we will be using from the corresponding packages."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "vblA",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "import os\n",
+ "import boto3\n",
+ "import json\n",
+ "from urllib.parse import quote_plus\n",
+ "from os.path import join, isfile, isdir\n",
+ "from urllib.request import urlretrieve\n",
+ "from anndata import read_h5ad\n",
+ "import scanpy as sc\n",
+ "\n",
+ "from vitessce import (\n",
+ " VitessceWidget,\n",
+ " VitessceConfig,\n",
+ " Component as cm,\n",
+ " CoordinationType as ct,\n",
+ " AnnDataWrapper,\n",
+ ")\n",
+ "from vitessce.data_utils import (\n",
+ " optimize_adata,\n",
+ " VAR_CHUNK_SIZE,\n",
+ ")"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "bkHC",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 2. Download and process data\n",
+ "\n",
+ "For this example, we need to download a dataset from the COVID-19 Cell Atlas https://www.covid19cellatlas.org/index.healthy.html#habib17."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "lEQa",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "adata_filepath = join(\"data\", \"habib17.processed.h5ad\")\n",
+ "if not isfile(adata_filepath):\n",
+ " os.makedirs(\"data\", exist_ok=True)\n",
+ " urlretrieve('https://covid19.cog.sanger.ac.uk/habib17.processed.h5ad', adata_filepath)\n",
+ "\n",
+ "adata = read_h5ad(adata_filepath)\n",
+ "top_dispersion = adata.var[\"dispersions_norm\"][\n",
+ " sorted(\n",
+ " range(len(adata.var[\"dispersions_norm\"])),\n",
+ " key=lambda k: adata.var[\"dispersions_norm\"][k],\n",
+ " )[-51:][0]\n",
+ "]\n",
+ "adata.var[\"top_highly_variable\"] = (\n",
+ " adata.var[\"dispersions_norm\"] > top_dispersion\n",
+ ")"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "PKri",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "zarr_filepath = join('data', 'habib17.processed.zarr')\n",
+ "if not isdir(zarr_filepath):\n",
+ " adata_1 = optimize_adata(adata, obs_cols=['CellType'], obsm_keys=['X_umap'], var_cols=['top_highly_variable'], optimize_X=True)\n",
+ " adata_1.write_zarr(zarr_filepath, chunks=[adata_1.shape[0], VAR_CHUNK_SIZE])"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "Xref",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 3. Create the Vitessce configuration"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "SFPL",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "Set up the configuration by adding the views and datasets of interest."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "BYtC",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "vc = VitessceConfig(schema_version=\"1.0.15\", name='Habib et al', description='COVID-19 Healthy Donor Brain')\n",
+ "dataset = vc.add_dataset(name='Brain').add_object(AnnDataWrapper(\n",
+ " adata_path=zarr_filepath,\n",
+ " obs_embedding_paths=[\"obsm/X_umap\"],\n",
+ " obs_embedding_names=[\"UMAP\"],\n",
+ " obs_set_paths=[\"obs/CellType\"],\n",
+ " obs_set_names=[\"Cell Type\"],\n",
+ " obs_feature_matrix_path=\"X\",\n",
+ " feature_filter_path=\"var/top_highly_variable\"\n",
+ "))\n",
+ "scatterplot = vc.add_view(cm.SCATTERPLOT, dataset=dataset, mapping=\"UMAP\")\n",
+ "cell_sets = vc.add_view(cm.OBS_SETS, dataset=dataset)\n",
+ "genes = vc.add_view(cm.FEATURE_LIST, dataset=dataset)\n",
+ "heatmap = vc.add_view(cm.HEATMAP, dataset=dataset)\n",
+ "vc.layout((scatterplot | (cell_sets / genes)) / heatmap);"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "RGSE",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 4. Create a `boto3` resource with S3 credentials"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "Kclp",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "s3 = boto3.resource(\n",
+ " service_name='s3',\n",
+ " aws_access_key_id=os.environ['VITESSCE_S3_ACCESS_KEY_ID'],\n",
+ " aws_secret_access_key=os.environ['VITESSCE_S3_SECRET_ACCESS_KEY'],\n",
+ ")"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "emfo",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 5. Upload files to S3\n",
+ "\n",
+ "The `.export(to='S3')` method on the view config instance will upload all data objects to the specified bucket. Then, the processed view config will be returned as a `dict`, with the file URLs filled in, pointing to the S3 bucket files. For more information about configuring the S3 bucket so that files are accessible over the internet, visit the \"Hosting Data\" page of our core documentation site."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "Hstk",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "config_dict = vc.export(to='S3', s3=s3, bucket_name='vitessce-export-examples', prefix='test')"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "nWHF",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## 6. View on vitessce.io\n",
+ "\n",
+ "The returned view config dict can be converted to a URL, and can be used to share the interactive visualizations with colleagues."
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "iLit",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "vitessce_url = \"http://vitessce.io/?url=data:,\" + quote_plus(json.dumps(config_dict))\n",
+ "import webbrowser\n",
+ "webbrowser.open(vitessce_url)"
+ ]
+ }
+ ],
+ "metadata": {
+ "kernelspec": {
+ "display_name": "Python 3 (ipykernel)",
+ "language": "python",
+ "name": "python3"
+ },
+ "language_info": {
+ "codemirror_mode": {
+ "name": "ipython",
+ "version": 3
+ },
+ "file_extension": ".py",
+ "mimetype": "text/x-python",
+ "name": "python",
+ "nbconvert_exporter": "python",
+ "pygments_lexer": "ipython3",
+ "version": "3.10.14"
+ }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 5
+}
\ No newline at end of file
diff --git a/docs/notebooks/__ipynb__/example_configs.py b/docs/notebooks/__ipynb__/example_configs.py
new file mode 100644
index 00000000..c965f282
--- /dev/null
+++ b/docs/notebooks/__ipynb__/example_configs.py
@@ -0,0 +1,107 @@
+dries = {
+ "name": "Dries",
+ "version": "1.0.0",
+ "description": "Giotto, a pipeline for integrative analysis and visualization of single-cell spatial transcriptomic data",
+ "public": True,
+ "datasets": [
+ {
+ "uid": 'dries-2019',
+ "name": 'Dries 2019',
+ "files": [
+ {
+ "type": "cells",
+ "fileType": "cells.json",
+ "url": "https://s3.amazonaws.com/vitessce-data/0.0.31/master_release/dries/dries.cells.json"
+ },
+ {
+ "type": "cell-sets",
+ "fileType": "cell-sets.json",
+ "url": "https://s3.amazonaws.com/vitessce-data/0.0.31/master_release/dries/dries.cell-sets.json"
+ }
+ ]
+ }
+ ],
+ "initStrategy": "auto",
+ "coordinationSpace": {
+ "embeddingType": {
+ "TSNE": 't-SNE',
+ "UMAP": 'UMAP',
+ },
+ "embeddingZoom": {
+ "TSNE": 3,
+ "UMAP": 3,
+ },
+ "spatialZoom": {
+ "A": -4.4,
+ },
+ "spatialTargetX": {
+ "A": 3800,
+ },
+ "spatialTargetY": {
+ "A": -900,
+ },
+ },
+ "layout": [
+ {
+ "component": "description",
+ "props": {
+ "description": "Giotto, a pipeline for integrative analysis and visualization of single-cell spatial transcriptomic data"
+ },
+ "x": 9,
+ "y": 0,
+ "w": 3,
+ "h": 4
+ },
+ {
+ "component": "cellSets",
+ "x": 9,
+ "y": 4,
+ "w": 3,
+ "h": 4
+ },
+ {
+ "component": "cellSetSizes",
+ "x": 5,
+ "y": 4,
+ "w": 4,
+ "h": 4
+ },
+ {
+ "component": "scatterplot",
+ "coordinationScopes": {
+ "embeddingType": 'TSNE',
+ "embeddingZoom": 'TSNE'
+ },
+ "x": 0,
+ "y": 2,
+ "w": 5,
+ "h": 4
+ },
+ {
+ "component": "spatial",
+ "props": {
+ "cellRadius": 50
+ },
+ "coordinationScopes": {
+ "spatialZoom": 'A',
+ "spatialTargetX": 'A',
+ "spatialTargetY": 'A'
+ },
+ "x": 5,
+ "y": 0,
+ "w": 4,
+ "h": 4
+ },
+ {
+ "component": "scatterplot",
+ "coordinationScopes": {
+ "embeddingType": 'UMAP',
+ "embeddingZoom": 'UMAP'
+ },
+ "x": 0,
+ "y": 0,
+ "w": 5,
+ "h": 4
+ }
+ ]
+}
diff --git a/docs/notebooks/__ipynb__/page_mode_comparative.ipynb b/docs/notebooks/__ipynb__/page_mode_comparative.ipynb
new file mode 100644
index 00000000..ec439c1a
--- /dev/null
+++ b/docs/notebooks/__ipynb__/page_mode_comparative.ipynb
@@ -0,0 +1,506 @@
+{
+ "cells": [
+ {
+ "cell_type": "markdown",
+ "id": "Hbol",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "# Visualization of ComparativeData object"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "MJUe",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## Configure Vitessce"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "vblA",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "from oxc_py import transform\n",
+ "from vitessce import VitessceConfig, hconcat, vconcat"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "bkHC",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## Configure the data and views"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "lEQa",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "# Reference: https://github.com/vitessce/vitessce/blob/main/examples/configs/src/view-configs/kpmp-premiere.js"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "PKri",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "base_url = 'https://storage.googleapis.com/vitessce-demo-data/kpmp-jan-2025/kpmp_premiere_20250330.adata.zarr'"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "Xref",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "vc = VitessceConfig(schema_version=\"1.0.17\", name='Lake et al.')\n",
+ "\n",
+ "dataset = vc.add_dataset('lake_et_al').add_file(\n",
+ " file_type='comparisonMetadata.anndata.zarr',\n",
+ " url=base_url,\n",
+ " options={\n",
+ " \"path\": 'uns/comparison_metadata',\n",
+ " },\n",
+ " coordination_values={\n",
+ " \"obsType\": 'cell',\n",
+ " \"sampleType\": 'sample',\n",
+ " },\n",
+ ").add_file(\n",
+ " file_type='comparativeFeatureStats.anndata.zarr',\n",
+ " url=base_url,\n",
+ " options= {\n",
+ " \"metadataPath\": 'uns/comparison_metadata',\n",
+ " \"indexColumn\": 'names',\n",
+ " \"pValueColumn\": 'pvals_adj',\n",
+ " \"foldChangeColumn\": 'logfoldchanges',\n",
+ " \"pValueAdjusted\": True,\n",
+ " \"foldChangeTransformation\": 'log2',\n",
+ " },\n",
+ " coordination_values={\n",
+ " \"obsType\": 'cell',\n",
+ " \"sampleType\": 'sample',\n",
+ " \"featureType\": 'gene',\n",
+ " },\n",
+ ").add_file(\n",
+ " file_type= 'comparativeObsSetStats.anndata.zarr',\n",
+ " url= base_url,\n",
+ " options= {\n",
+ " \"metadataPath\": 'uns/comparison_metadata',\n",
+ " \"indexColumn\": 'Cell Type',\n",
+ " \"interceptExpectedSampleColumn\": 'Expected Sample_intercept',\n",
+ " \"effectExpectedSampleColumn\": 'Expected Sample_effect',\n",
+ " \"foldChangeColumn\": 'log2-fold change',\n",
+ " \"foldChangeTransformation\": 'log2',\n",
+ " \"isCredibleEffectColumn\": 'is_credible_effect',\n",
+ " },\n",
+ " coordination_values= {\n",
+ " \"obsType\": 'cell',\n",
+ " \"sampleType\": 'sample',\n",
+ " },\n",
+ ").add_file(\n",
+ " file_type='comparativeFeatureSetStats.anndata.zarr',\n",
+ " url=base_url,\n",
+ " options= {\n",
+ " \"metadataPath\": 'uns/comparison_metadata',\n",
+ " \"indexColumn\": 'pathway_name',\n",
+ " \"termColumn\": 'pathway_term',\n",
+ " \"pValueColumn\": 'pvals_adj',\n",
+ " \"pValueAdjusted\": True,\n",
+ " \"analysisType\": 'pertpy_hypergeometric',\n",
+ " \"featureSetLibrary\": 'Reactome_2022',\n",
+ " },\n",
+ " coordination_values= {\n",
+ " \"obsType\": 'cell',\n",
+ " \"featureType\": 'gene',\n",
+ " \"sampleType\": 'sample',\n",
+ " },\n",
+ ").add_file(\n",
+ " file_type='anndata.zarr',\n",
+ " url=base_url,\n",
+ " coordination_values={\n",
+ " \"obsType\": 'cell',\n",
+ " \"featureType\": 'gene',\n",
+ " \"featureValueType\": 'expression',\n",
+ " \"sampleType\": 'sample',\n",
+ " },\n",
+ " options={\n",
+ " \"obsFeatureMatrix\": {\n",
+ " \"path\": 'layers/pearson_residuals',\n",
+ " },\n",
+ " \"obsEmbedding\": [\n",
+ " {\n",
+ " \"path\": 'obsm/X_densmap',\n",
+ " \"embeddingType\": 'densMAP',\n",
+ " },\n",
+ " ],\n",
+ " \"obsSets\": [\n",
+ " {\n",
+ " \"name\": 'Cell Type',\n",
+ " \"path\": 'obs/cell_type',\n",
+ " },\n",
+ " {\n",
+ " \"name\": 'Subclass L1',\n",
+ " \"path\": 'obs/subclass_l1',\n",
+ " },\n",
+ " {\n",
+ " \"name\": 'Subclass L2',\n",
+ " \"path\": 'obs/subclass_l2',\n",
+ " },\n",
+ " {\n",
+ " \"name\": 'Donor ID',\n",
+ " \"path\": 'obs/donor_id',\n",
+ " },\n",
+ " ],\n",
+ " \"sampleEdges\": {\n",
+ " \"path\": 'obs/SampleID',\n",
+ " },\n",
+ " },\n",
+ ").add_file(\n",
+ " file_type='sampleSets.anndata.zarr',\n",
+ " url=f\"{base_url}/uns/__all__.samples\",\n",
+ " options={\n",
+ " \"sampleSets\": [\n",
+ " {\n",
+ " \"name\": 'Disease Type',\n",
+ " \"path\": 'diseasetype',\n",
+ " },\n",
+ " {\n",
+ " \"name\": 'Adjudicated Category',\n",
+ " \"path\": 'AdjudicatedCategory',\n",
+ " },\n",
+ " {\n",
+ " \"name\": 'Enrollment Category',\n",
+ " \"path\": 'EnrollmentCategory',\n",
+ " },\n",
+ " ],\n",
+ " },\n",
+ " coordination_values= {\n",
+ " \"sampleType\": 'sample',\n",
+ " },\n",
+ ")\n",
+ "\n",
+ "biomarkerSelect = vc.add_view('biomarkerSelect', dataset=dataset, uid='biomarker-select')\n",
+ "comparativeHeading = vc.add_view('comparativeHeading', dataset=dataset, uid='comparative-heading')\n",
+ "dualScatterplot = vc.add_view('dualScatterplot', dataset=dataset, uid='scatterplot')\n",
+ "obsSets = vc.add_view('obsSets', dataset=dataset, uid='cell-sets')\n",
+ "sampleSets = vc.add_view('sampleSetPairManager', dataset=dataset, uid='sample-sets')\n",
+ "obsSetSizes = vc.add_view('obsSetSizes', dataset=dataset)\n",
+ "featureList = vc.add_view('featureList', dataset=dataset)\n",
+ "violinPlots = vc.add_view('obsSetFeatureValueDistribution', dataset=dataset, uid='violin-plot')\n",
+ "dotPlot = vc.add_view('dotPlot', dataset=dataset, uid='dot-plot')\n",
+ "treemap = vc.add_view('treemap', dataset=dataset, uid='treemap')\n",
+ "volcanoPlot = vc.add_view('volcanoPlot', dataset=dataset, uid='volcano-plot')\n",
+ "volcanoPlotTable = vc.add_view('featureStatsTable', dataset=dataset, uid='volcano-plot-table')\n",
+ "obsSetCompositionBarPlot = vc.add_view('obsSetCompositionBarPlot', dataset=dataset, uid='sccoda-plot')\n",
+ "featureSetEnrichmentBarPlot = vc.add_view('featureSetEnrichmentBarPlot', dataset=dataset, uid='pathways-plot')\n",
+ "\n",
+ "[sampleSetScope_caseControl] = vc.add_coordination('sampleSetSelection')\n",
+ "sampleSetScope_caseControl.set_value([['Disease Type', 'CKD'], ['Disease Type', 'Reference']])\n",
+ "\n",
+ "[featureSelectionScope] = vc.add_coordination('featureSelection')\n",
+ "featureSelectionScope.set_value(['UMOD', 'NPHS2'])\n",
+ "\n",
+ "vc.link_views_by_dict([dualScatterplot], {\n",
+ " \"embeddingType\": 'densMAP',\n",
+ " \"embeddingContoursVisible\": True,\n",
+ " \"embeddingPointsVisible\": False,\n",
+ " \"embeddingObsSetLabelsVisible\": True,\n",
+ "}, meta=False);\n",
+ "\n",
+ "\n",
+ "vc.link_views([biomarkerSelect, dualScatterplot, obsSets, obsSetSizes, featureList, violinPlots, dotPlot, treemap, volcanoPlot, volcanoPlotTable, comparativeHeading, obsSetCompositionBarPlot, featureSetEnrichmentBarPlot, sampleSets], ['sampleType'], ['sample'])\n",
+ "\n",
+ "vc.link_views_by_dict([biomarkerSelect, dualScatterplot, obsSets, obsSetSizes, featureList, violinPlots, dotPlot, treemap, volcanoPlot, volcanoPlotTable, comparativeHeading, obsSetCompositionBarPlot, featureSetEnrichmentBarPlot, sampleSets], {\n",
+ " \"sampleSetSelection\": sampleSetScope_caseControl,\n",
+ " \"featureSelection\": featureSelectionScope,\n",
+ "}, meta=False)\n",
+ "\n",
+ "vc.link_views_by_dict([dualScatterplot, violinPlots, featureList, dotPlot], {\n",
+ " # \"featureSelection\": ['UMOD', 'NPHS2'], // , 'ENSG00000074803', 'ENSG00000164825'],\n",
+ " \"obsColorEncoding\": 'geneSelection',\n",
+ " \"featureValueColormap\": 'jet',\n",
+ " \"featureValueColormapRange\": [0, 0.25],\n",
+ " \"featureAggregationStrategy\": None,\n",
+ "}, meta=False)\n",
+ "\n",
+ "vc.layout(hconcat(\n",
+ " vconcat(dualScatterplot, biomarkerSelect, comparativeHeading, obsSets, obsSetSizes, featureList),\n",
+ " vconcat(treemap, featureSetEnrichmentBarPlot, violinPlots, dotPlot, obsSetCompositionBarPlot, sampleSets),\n",
+ " volcanoPlotTable,\n",
+ "));"
+ ]
+ },
+ {
+ "cell_type": "markdown",
+ "id": "SFPL",
+ "metadata": {
+ "marimo": {
+ "config": {
+ "hide_code": true
+ }
+ }
+ },
+ "source": [
+ "## Define the page layout"
+ ]
+ },
+ {
+ "cell_type": "code",
+ "execution_count": null,
+ "id": "BYtC",
+ "metadata": {},
+ "outputs": [],
+ "source": [
+ "PAGE_ESM = transform(\"\"\"\n",
+ "import clsx from \"https://unpkg.com/clsx@1.1.1/dist/clsx.m.js\";\n",
+ "\n",
+ "function createPage(utilsForPages) {\n",
+ " const {\n",
+ " React,\n",
+ " usePageModeView,\n",
+ " } = utilsForPages;\n",
+ " function PageComponent(props) {\n",
+ " const BiomarkerSelect = usePageModeView('biomarker-select');\n",
+ " const ComparativeHeading = usePageModeView('comparative-heading');\n",
+ " const CellSets = usePageModeView('cell-sets');\n",
+ " const SampleSets = usePageModeView('sample-sets');\n",
+ " const DualScatterplot = usePageModeView('scatterplot');\n",
+ " const ViolinPlot = usePageModeView('violin-plot');\n",
+ " const DotPlot = usePageModeView('dot-plot');\n",
+ " const Treemap = usePageModeView('treemap');\n",
+ " const VolcanoPlot = usePageModeView('volcano-plot');\n",
+ " const VolcanoPlotTable = usePageModeView('volcano-plot-table');\n",
+ " const SccodaPlot = usePageModeView('sccoda-plot');\n",
+ " const PathwaysPlot = usePageModeView('pathways-plot');\n",
+ "\n",
+ "\n",
+ " return (\n",
+ " <>\n",
+ " \n",
+ " \n",
+ "
\n",
+ "
Comparative visualization of single-cell atlas data \n",
+ " \n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
This view contains a treemap visualization to communicate cell type composition in each of the selected sample groups.
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
This view displays the results of a cell type composition analysis performed using the ScCODA algorithm (B\u00fcttner et al. 2021). Cell types with significantly different composition between the selected sample groups are displayed opaque while not-signficant results are displayed with transparent bars. The single outlined bar denotes the automatically-selected reference cell type.
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
This view displays differential expression test results, performed using the rank_genes_groups function from Scanpy (Wolf et al. 2018) with method "wilcoxon".
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
This view displays differential expression test results in tabular form. Click a row in the table to select the corresponding gene.
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
This view displays gene set enrichment test results based on the differential expression results. Gene set enrichment tests have been performed using Reactome 2022 pathway gene sets from BlitzGSEA (Lachmann et al. 2022) via the hypergeometric function of Pertpy (Heumos et al. 2024).
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
This view contains contour scatterplots which display the results of a density-preserving dimensionality reduction (Narayan et al. 2021). Contour opacities correspond to the shown percentile thresholds.
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
This dot plot view displays gene expression values per cell type and sample group for the selected biomarkers.
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
This violin plot view displays gene expression values per cell type and sample group for the selected biomarker.
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ " {/*
Neighborhood-level representations \n",
+ "
TODO \n",
+ "
Segmented instance-level representations \n",
+ "
TODO \n",
+ "
Image-level representations \n",
+ "
TODO \n",
+ "
Participant-level representations \n",
+ "
TODO */}\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "\n",
+ "
\n",
+ "
\n",
+ "
This is an arbitrary HTML element with custom CSS \n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
Another HTML element \n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
\n",
+ "
Chat view
\n",
+ "
\n",
+ " {chatHistory.map(message => (\n",
+ "
\n",
+ " {message.user} :\n",
+ " {message.text} \n",
+ "
\n",
+ " ))}\n",
+ "
\n",
+ "
setNextMessage(e.target.value)} disabled={isLoading} />\n",
+ "
Send message \n",
+ "
\n",
- "
\n",
- "
Comparative visualization of single-cell atlas data \n",
- " \n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
This view contains a treemap visualization to communicate cell type composition in each of the selected sample groups.
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
This view displays the results of a cell type composition analysis performed using the ScCODA algorithm (Büttner et al. 2021). Cell types with significantly different composition between the selected sample groups are displayed opaque while not-signficant results are displayed with transparent bars. The single outlined bar denotes the automatically-selected reference cell type.
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
This view displays differential expression test results, performed using the rank_genes_groups function from Scanpy (Wolf et al. 2018) with method "wilcoxon".
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
This view displays differential expression test results in tabular form. Click a row in the table to select the corresponding gene.
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
This view displays gene set enrichment test results based on the differential expression results. Gene set enrichment tests have been performed using Reactome 2022 pathway gene sets from BlitzGSEA (Lachmann et al. 2022) via the hypergeometric function of Pertpy (Heumos et al. 2024).
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
This view contains contour scatterplots which display the results of a density-preserving dimensionality reduction (Narayan et al. 2021). Contour opacities correspond to the shown percentile thresholds.
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
This dot plot view displays gene expression values per cell type and sample group for the selected biomarkers.
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
This violin plot view displays gene expression values per cell type and sample group for the selected biomarker.
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- " {/*
Neighborhood-level representations \n",
- "
TODO \n",
- "
Segmented instance-level representations \n",
- "
TODO \n",
- "
Image-level representations \n",
- "
TODO \n",
- "
Participant-level representations \n",
- "
TODO */}\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "\n",
- "
+
+
Comparative visualization of single-cell atlas data
+
+
+
+
+
+
+
+
This view contains a treemap visualization to communicate cell type composition in each of the selected sample groups.
+
+
+
+
+
+
+
This view displays the results of a cell type composition analysis performed using the ScCODA algorithm (Büttner et al. 2021). Cell types with significantly different composition between the selected sample groups are displayed opaque while not-signficant results are displayed with transparent bars. The single outlined bar denotes the automatically-selected reference cell type.
+
+
+
+
+
+
+
This view displays differential expression test results, performed using the rank_genes_groups function from Scanpy (Wolf et al. 2018) with method "wilcoxon".
+
+
+
+
+
+
+
This view displays differential expression test results in tabular form. Click a row in the table to select the corresponding gene.
+
+
+
+
+
+
+
This view displays gene set enrichment test results based on the differential expression results. Gene set enrichment tests have been performed using Reactome 2022 pathway gene sets from BlitzGSEA (Lachmann et al. 2022) via the hypergeometric function of Pertpy (Heumos et al. 2024).
+
+
+
+
+
+
This view contains contour scatterplots which display the results of a density-preserving dimensionality reduction (Narayan et al. 2021). Contour opacities correspond to the shown percentile thresholds.
+
+
+
+
+
+
+
This dot plot view displays gene expression values per cell type and sample group for the selected biomarkers.
+
+
+
+
+
+
+
This violin plot view displays gene expression values per cell type and sample group for the selected biomarker.
+
+
+
+
+ {/*
Neighborhood-level representations
+
TODO
+
Segmented instance-level representations
+
TODO
+
Image-level representations
+
TODO
+
Participant-level representations
+
TODO */}
+
+
+
+
\n",
- "
\n",
- "
This is an arbitrary HTML element with custom CSS \n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
Another HTML element \n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
\n",
- "
+
+
This is an arbitrary HTML element with custom CSS
+
+
Another HTML element
+
+
+
+
+
+
\n",
- "
Chat view
\n",
- "
\n",
- " {chatHistory.map(message => (\n",
- "
\n",
- " {message.user} :\n",
- " {message.text} \n",
- "
\n",
- " ))}\n",
- "
\n",
- "
setNextMessage(e.target.value)} disabled={isLoading} />\n",
- "
Send message \n",
- "
+
Chat view
+
+ {chatHistory.map(message => (
+
+ {message.user} :
+ {message.text}
+
+ ))}
+
+
setNextMessage(e.target.value)} disabled={isLoading} />
+
Send message
+