scientific-skills/scvi-tools/references/models-spatial.md
This document covers models for analyzing spatially-resolved transcriptomics data in scvi-tools.
Purpose: Multi-resolution deconvolution of spatial transcriptomics using single-cell reference data.
Key Features:
When to Use:
Data Requirements:
Basic Usage:
import scvi
# Step 1: Train scVI on single-cell reference
scvi.model.SCVI.setup_anndata(sc_adata, layer="counts")
sc_model = scvi.model.SCVI(sc_adata)
sc_model.train()
# Step 2: Setup spatial data
scvi.model.DESTVI.setup_anndata(
spatial_adata,
layer="counts"
)
# Step 3: Train DestVI using reference
model = scvi.model.DESTVI.from_rna_model(
spatial_adata,
sc_model,
cell_type_key="cell_type" # Cell type labels in reference
)
model.train(max_epochs=2500)
# Step 4: Get cell type proportions
proportions = model.get_proportions()
spatial_adata.obsm["proportions"] = proportions
# Step 5: Get cell type-specific expression
# Expression of genes specific to each cell type at each spot
ct_expression = model.get_scale_for_ct("T cells")
Key Parameters:
amortization: Amortization strategy ("both", "latent", "proportion")n_latent: Latent dimensionality (inherited from scVI model)Outputs:
get_proportions(): Cell type proportions at each spotget_scale_for_ct(cell_type): Cell type-specific expression patternsget_gamma(): Proportion-specific gene expression scalingVisualization:
import scanpy as sc
import matplotlib.pyplot as plt
# Visualize specific cell type proportions spatially
sc.pl.spatial(
spatial_adata,
color="T cells", # If proportions added to .obs
spot_size=150
)
# Or use obsm directly
for ct in cell_types:
plt.figure()
sc.pl.spatial(
spatial_adata,
color=spatial_adata.obsm["proportions"][ct],
title=f"{ct} proportions"
)
Purpose: Cell type deconvolution for spatial transcriptomics using probabilistic modeling.
Key Features:
When to Use:
Basic Usage:
scvi.model.STEREOSCOPE.setup_anndata(
sc_adata,
labels_key="cell_type",
layer="counts"
)
# Train on reference
ref_model = scvi.model.STEREOSCOPE(sc_adata)
ref_model.train()
# Setup spatial data
scvi.model.STEREOSCOPE.setup_anndata(spatial_adata, layer="counts")
# Transfer to spatial
spatial_model = scvi.model.STEREOSCOPE.from_reference_model(
spatial_adata,
ref_model
)
spatial_model.train()
# Get proportions
proportions = spatial_model.get_proportions()
Purpose: Spatial mapping and integration of single-cell data to spatial locations.
Key Features:
When to Use:
Data Requirements:
Basic Usage:
import tangram as tg
# Map cells to spatial locations
ad_map = tg.map_cells_to_space(
adata_sc=sc_adata,
adata_sp=spatial_adata,
mode="cells", # or "clusters" for cell type mapping
density_prior="rna_count_based"
)
# Get mapping matrix (cells × spots)
mapping = ad_map.X
# Project cell annotations to space
tg.project_cell_annotations(
ad_map,
spatial_adata,
annotation="cell_type"
)
# Impute genes in spatial data
genes_to_impute = ["CD3D", "CD8A", "CD4"]
tg.project_genes(ad_map, spatial_adata, genes=genes_to_impute)
Visualization:
# Visualize cell type mapping
sc.pl.spatial(
spatial_adata,
color="cell_type_projected",
spot_size=100
)
Purpose: Cross-modality imputation between spatial and single-cell data.
Key Features:
When to Use:
Basic Usage:
# Combine datasets
combined_adata = sc.concat([sc_adata, spatial_adata])
scvi.model.GIMVI.setup_anndata(
combined_adata,
layer="counts"
)
model = scvi.model.GIMVI(combined_adata)
model.train()
# Impute genes in spatial data
imputed = model.get_imputed_values(spatial_indices)
Purpose: Analyzing cell-environment relationships in spatial data.
Key Features:
When to Use:
Data Requirements:
Basic Usage:
scvi.model.SCVIVA.setup_anndata(
spatial_adata,
layer="counts",
spatial_key="spatial" # Coordinates in .obsm
)
model = scvi.model.SCVIVA(spatial_adata)
model.train()
# Get environment representations
env_latent = model.get_environment_representation()
# Identify environment-associated genes
env_genes = model.get_environment_specific_genes()
Purpose: Addressing spatial transcriptomics noise through resolution-aware modeling.
Key Features:
When to Use:
Basic Usage:
scvi.model.RESOLVI.setup_anndata(
spatial_adata,
layer="counts",
spatial_key="spatial"
)
model = scvi.model.RESOLVI(spatial_adata)
model.train()
# Get denoised expression
denoised = model.get_denoised_expression()
Choose when:
Best for: Visium, spot-based technologies
Choose when:
Best for: Quick deconvolution tasks
Choose when:
Best for: Detailed spatial mapping
Choose when:
Best for: Integration and imputation
Choose when:
Best for: Microenvironment studies
Choose when:
Best for: Noisy data preprocessing
import scvi
import scanpy as sc
import squidpy as sq
# ===== Part 1: Prepare single-cell reference =====
# Load and process scRNA-seq reference
sc_adata = sc.read_h5ad("reference_scrna.h5ad")
# QC and filtering
sc.pp.filter_genes(sc_adata, min_cells=10)
sc.pp.highly_variable_genes(sc_adata, n_top_genes=4000)
# Train scVI on reference
scvi.model.SCVI.setup_anndata(
sc_adata,
layer="counts",
batch_key="batch"
)
sc_model = scvi.model.SCVI(sc_adata)
sc_model.train(max_epochs=400)
# ===== Part 2: Load spatial data =====
spatial_adata = sc.read_visium("path/to/visium")
spatial_adata.var_names_make_unique()
# QC spatial data
sc.pp.filter_genes(spatial_adata, min_cells=10)
# ===== Part 3: Run DestVI =====
scvi.model.DESTVI.setup_anndata(
spatial_adata,
layer="counts"
)
destvi_model = scvi.model.DESTVI.from_rna_model(
spatial_adata,
sc_model,
cell_type_key="cell_type"
)
destvi_model.train(max_epochs=2500)
# ===== Part 4: Extract results =====
# Get proportions
proportions = destvi_model.get_proportions()
spatial_adata.obsm["proportions"] = proportions
# Add proportions to .obs for easy plotting
for i, ct in enumerate(sc_model.adata.obs["cell_type"].cat.categories):
spatial_adata.obs[f"prop_{ct}"] = proportions[:, i]
# ===== Part 5: Visualization =====
# Plot specific cell types
cell_types = ["T cells", "B cells", "Macrophages"]
for ct in cell_types:
sc.pl.spatial(
spatial_adata,
color=f"prop_{ct}",
title=f"{ct} proportions",
spot_size=150,
cmap="viridis"
)
# ===== Part 6: Spatial analysis =====
# Compute spatial neighbors
sq.gr.spatial_neighbors(spatial_adata)
# Spatial autocorrelation of cell types
for ct in cell_types:
sq.gr.spatial_autocorr(
spatial_adata,
attr="obs",
mode="moran",
genes=[f"prop_{ct}"]
)
# ===== Part 7: Save results =====
destvi_model.save("destvi_model")
spatial_adata.write("spatial_deconvolved.h5ad")
.obsm["spatial"]