This page was generated from PeakVI.ipynb. Interactive online version: Colab badge. Some tutorial content may look better in light mode.

PeakVI: Analyzing scATACseq data#

PeakVI is used for analyzing scATACseq data. This tutorial walks through how to read, set-up and train the model, accessing and visualizing the latent space, and differential accessibility. We use the 5kPBMC sample dataset from 10X but these steps can be easily adjusted for other datasets.

[ ]:
!pip install --quiet scvi-colab
from scvi_colab import install

import anndata
import matplotlib.pyplot as plt
import numpy as np
import pandas as pd
import scanpy as sc
import scipy
import scvi
     |████████████████████████████████| 72 kB 1.2 MB/s
ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
nbclient 0.5.11 requires jupyter-client>=6.1.5, but you have jupyter-client 5.3.5 which is incompatible.
  Installing build dependencies ... done
  Getting requirements to build wheel ... done
    Preparing wheel metadata ... done
     |████████████████████████████████| 713 kB 14.8 MB/s
     |████████████████████████████████| 217 kB 71.0 MB/s
     |████████████████████████████████| 91 kB 11.8 MB/s
     |████████████████████████████████| 397 kB 76.8 MB/s
     |████████████████████████████████| 527 kB 72.1 MB/s
     |████████████████████████████████| 2.0 MB 66.4 MB/s
     |████████████████████████████████| 8.8 MB 33.1 MB/s
     |████████████████████████████████| 1.1 MB 57.5 MB/s
     |████████████████████████████████| 1.4 MB 56.4 MB/s
     |████████████████████████████████| 41 kB 144 kB/s
     |████████████████████████████████| 134 kB 67.6 MB/s
     |████████████████████████████████| 48 kB 6.9 MB/s
     |████████████████████████████████| 952 kB 63.9 MB/s
     |████████████████████████████████| 596 kB 74.5 MB/s
     |████████████████████████████████| 829 kB 72.7 MB/s
     |████████████████████████████████| 134 kB 69.9 MB/s
     |████████████████████████████████| 1.1 MB 65.7 MB/s
     |████████████████████████████████| 51 kB 9.5 MB/s
     |████████████████████████████████| 86 kB 7.8 MB/s
     |████████████████████████████████| 97 kB 9.3 MB/s
     |████████████████████████████████| 94 kB 2.7 MB/s
     |████████████████████████████████| 144 kB 74.4 MB/s
     |████████████████████████████████| 271 kB 76.2 MB/s
     |████████████████████████████████| 3.1 MB 59.9 MB/s
     |████████████████████████████████| 63 kB 2.8 MB/s
  Building wheel for scvi-tools (PEP 517) ... done
  Building wheel for docrep ( ... done
  Building wheel for loompy ( ... done
  Building wheel for future ( ... done
  Building wheel for umap-learn ( ... done
  Building wheel for pynndescent ( ... done
  Building wheel for numpy-groupies ( ... done
  Building wheel for sinfo ( ... done
ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
tensorflow 2.8.0 requires tf-estimator-nightly==2.8.0.dev2021122109, which is not installed.
datascience 0.10.6 requires folium==0.2.1, but you have folium 0.8.3 which is incompatible.

First we need to download the sample data. This block will do this for a google colab session, but if you’re running it in a different platform you might need to adjust it, or download and unpack the data manually.

!tar -xvf atac_pbmc_5k_nextgem_filtered_peak_bc_matrix.tar.gz

--2022-02-28 04:36:25--
Resolving (,, 2606:4700::6812:1ad, ...
Connecting to (||:443... connected.
HTTP request sent, awaiting response... 200 OK
Length: 114015463 (109M) [application/x-tar]
Saving to: ‘atac_pbmc_5k_nextgem_filtered_peak_bc_matrix.tar.gz’

atac_pbmc_5k_nextge 100%[===================>] 108.73M  26.4MB/s    in 5.1s

2022-02-28 04:36:31 (21.2 MB/s) - ‘atac_pbmc_5k_nextgem_filtered_peak_bc_matrix.tar.gz’ saved [114015463/114015463]

scvi.settings.seed = 420

sc.set_figure_params(figsize=(4, 4), frameon=False)

%config InlineBackend.print_figure_kwargs={'facecolor' : "w"}
%config InlineBackend.figure_format='retina'
Global seed set to 0
/usr/local/lib/python3.7/dist-packages/numba/np/ufunc/ NumbaWarning: The TBB threading layer requires TBB version 2019.5 or later i.e., TBB_INTERFACE_VERSION >= 11005. Found TBB_INTERFACE_VERSION = 9107. The TBB threading layer is disabled.
Global seed set to 420

loading data#

PeakVI expects as input an AnnData object with a cell-by-region matrix. There are various pipelines that handle preprocessing of scATACseq to obtain this matrix from the sequencing data. If the data was generated by 10X genomics, this matrix is among the standard outputs of CellRanger. Other pipelines, like SnapATAC and ArchR, also generate similar matrices.

In the case of 10X data, PeakVI has a special reader function that reads the files and creates an AnnData object, demonstrated below. For conveniece, we also demonstrate how to initialize an AnnData object from scratch.

Throughout this tutorial, we use sample scATACseq data from 10X of 5K PBMCs.

# read the count matrix into a sparse matrix, and the cell and region annotations as pandas DataFrames
counts ="filtered_peak_bc_matrix/matrix.mtx").T
regions = pd.read_csv(
    names=["chr", "start", "end"],
cells = pd.read_csv(
    "filtered_peak_bc_matrix/barcodes.tsv", header=None, names=["barcodes"]

# then initialize a new AnnData object
adata = anndata.AnnData(X=counts, obs=cells, var=regions)

# or use this methods to read 10x data directly
adata ="filtered_peak_bc_matrix")
/usr/local/lib/python3.7/dist-packages/anndata/_core/ ImplicitModificationWarning: Transforming to str index.
  warnings.warn("Transforming to str index.", ImplicitModificationWarning)

we can use scanpy functions to handle, filter, and manipulate the data. In our case, we might want to filter out peaks that are rarely detected, to make the model train faster:

# compute the threshold: 5% of the cells
min_cells = int(adata.shape[0] * 0.05)
# in-place filtering of regions
sc.pp.filter_genes(adata, min_cells=min_cells)
(4585, 115554)
(4585, 33142)

set up, training, saving, and loading#

We can now set up the AnnData object, which will ensure everything the model needs is in place for training.

This is also the stage where we can condition the model on additional covariates, which encourages the model to remove the impact of those covariates from the learned latent space. Our sample data is a single batch, so we won’t demonstrate this directly, but it can be done simply by setting the batch_key argument to the annotation to be used as a batch covariate (must be a valid key in adata.obs) .


We can now create a PeakVI model object and train it!

Importantly: the default max epochs is set to 500, but in practice PeakVI stops early once the model converges, which rarely requires that many, especially for large datasets (which require fewer epochs to converge, since each epoch includes letting the model view more data). So the estimated runtime is usually a substantial overestimate of the actual runtime. In the case of the data we use for this tutorial, it used less than half of the max epochs!

pvi = scvi.model.PEAKVI(adata)
GPU available: True, used: True
TPU available: False, using: 0 TPU cores
IPU available: False, using: 0 IPUs
Epoch 299/500:  60%|█████▉    | 299/500 [05:12<03:29,  1.04s/it, loss=1.93e+08, v_num=1]
Monitored metric reconstruction_loss_validation did not improve in the last 50 records. Best score: 12754.396. Signaling Trainer to stop.

since training a model can take a while, we recommend saving the trained model after training, just in case.

[8]:"trained_model", overwrite=True)

We can then load the model later, which require providing an AnnData object that is structured similarly to the one used for training (or, in most cases, the same one):

pvi = scvi.model.PEAKVI.load("trained_model", adata=adata)

visualizing and analyzing the latent space#

We can now use the trained model to visualize, cluster, and analyze the data. We first extract the latent representation from the model, and save it back into our AnnData object:

latent = pvi.get_latent_representation()
adata.obsm["X_PeakVI"] = latent

(4585, 13)

We can now use scanpy functions to cluster and visualize our latent space:

# compute the k-nearest-neighbor graph that is used in both clustering and umap algorithms
sc.pp.neighbors(adata, use_rep="X_PeakVI")
# compute the umap, min_dist=0.2)
# cluster the space (we use a lower resolution to get fewer clusters than the default), key_added="cluster_pvi", resolution=0.2)
[14]:, color="cluster_pvi")
/usr/local/lib/python3.7/dist-packages/anndata/_core/ FutureWarning: The `inplace` parameter in pandas.Categorical.reorder_categories is deprecated and will be removed in a future version. Reordering categories will always return a new Categorical object.
  c.reorder_categories(natsorted(c.categories), inplace=True)
... storing 'chr' as categorical

differential accessibility#

Finally, we can use PeakVI to identify regions that are differentially accessible. There are many different ways to run this analysis, but the simplest is comparing one cluster against all others, or comparing two clusters to each other. In the first case we’ll be looking for marker-regions, so we’ll mostly want a one-sided test (the significant regions will only be the ones preferentially accessible in our target cluster). In the second case we’ll use a two-sided test to find regions that are differentially accessible, regardless of direction.

We demonstrate both of these next, and do this in two different ways: (1) more convenient but less flexible: using an existing factor to group the cells, and then comparing groups. (2) more flexible: using cell indices directly.

If the data includes multiple batches, we encourage setting batch_correction=True so the model will sample from multiple batches when computing the differential signal. We do this below despite the data only having a single batch, as a demonstration.

# (1.1) using a known factor to compare two clusters
## two-sided is True by default, but included here for emphasis
da_res11 = pvi.differential_accessibility(
    groupby="cluster_pvi", group1="3", group2="0", two_sided=True

# (1.2) using a known factor to compare a cluster against all other clusters
## if we only provide group1, group2 is all other cells by default
da_res12 = pvi.differential_accessibility(
    groupby="cluster_pvi", group1="3", two_sided=False

# (2.1) using indices to compare two clusters
## we can use boolean masks or integer indices for the `idx1` and `idx2` arguments
da_res21 = pvi.differential_accessibility(
    idx1=adata.obs.cluster_pvi == "3",
    idx2=adata.obs.cluster_pvi == "0",
# (2.2) using indices to compare a cluster against all other clusters
## if we don't provide idx2, it uses all other cells as the contrast
da_res22 = pvi.differential_accessibility(
    idx1=np.where(adata.obs.cluster_pvi == "3"),

DE...: 100%|██████████| 1/1 [00:13<00:00, 13.24s/it]
DE...: 100%|██████████| 1/1 [00:10<00:00, 10.79s/it]
DE...: 100%|██████████| 1/1 [00:10<00:00, 10.90s/it]
DE...: 100%|██████████| 1/1 [00:10<00:00, 10.87s/it]
prob_da is_da_fdr bayes_factor effect_size emp_effect est_prob1 est_prob2 emp_prob1 emp_prob2
chr11:45951188-45953584 1.0 True 18.420681 -0.727015 -0.400252 0.905678 0.178663 0.496629 0.096377
chr4:115519248-115520882 1.0 True 18.420681 -0.722754 -0.389592 0.756693 0.033939 0.406742 0.017150
chr3:13151900-13153013 1.0 True 18.420681 -0.873769 -0.480087 0.924364 0.050595 0.507865 0.027778
chr2:47951226-47952150 1.0 True 18.420681 -0.837306 -0.439850 0.862172 0.024866 0.451685 0.011836
chr11:60222766-60223569 1.0 True 18.420681 -0.884811 -0.512484 0.905579 0.020768 0.523596 0.011111

Note that da_res11 and da_res21 are equivalent, as are da_res12 and da_res22. The return value is a pandas DataFrame with the differential results and basic properties of the comparison:

prob_da in our case is the probability of cells from cluster 0 being more than 0.05 (the default minimal effect) more accessible than cells from the rest of the data.

is_da_fdr is a conservative classification (True/False) of whether a region is differential accessible. This is one way to threshold the results.

bayes_factor is a statistical significance score. It doesn’t have a commonly acceptable threshold (e.g 0.05 for p-values), bu we demonstrate below that it’s well calibrated to the effect size.

effect_size is the effect size, calculated as est_prob1 - est_prob2.

emp_effect is the empirical effect size, calculated as emp_prob1 - emp_prob2.

est_prob{1,2} are the estimated probabilities of accessibility in group1 and group2.

emp_prob{1,2} are the empirical probabilities of detection (how many cells in group X was the region detected in).

We can make sure the probability of DA is well calibrated, and look at the regions that are identified as differentially accessible:

plt.scatter(da_res22.effect_size, da_res22.prob_da, s=1)
plt.xlabel("effect size")
plt.ylabel("probability of DA")

da_res22.loc[da_res22.is_da_fdr].sort_values("prob_da", ascending=False).head(10)
prob_da is_da_fdr bayes_factor effect_size emp_effect est_prob1 est_prob2 emp_prob1 emp_prob2
chr11:45951188-45953584 1.0000 True 18.420681 -0.727015 -0.400252 0.905678 0.178663 0.496629 0.096377
chr2:47951226-47952150 1.0000 True 18.420681 -0.837306 -0.439850 0.862172 0.024866 0.451685 0.011836
chr11:60222766-60223569 1.0000 True 18.420681 -0.884811 -0.512484 0.905579 0.020768 0.523596 0.011111
chr4:115519248-115520882 1.0000 True 18.420681 -0.722754 -0.389592 0.756693 0.033939 0.406742 0.017150
chr3:13151900-13153013 1.0000 True 18.420681 -0.873769 -0.480087 0.924364 0.050595 0.507865 0.027778
chr10:126289468-126291985 0.9998 True 8.516943 -0.892011 -0.477137 0.932383 0.040372 0.498876 0.021739
chr22:22776937-22777587 0.9998 True 8.516943 -0.686266 -0.349940 0.727352 0.041086 0.368539 0.018599
chr9:37408865-37409992 0.9998 True 8.516943 -0.854023 -0.500657 0.941401 0.087378 0.546067 0.045411
chr22:22522044-22523273 0.9998 True 8.516943 -0.762959 -0.404079 0.868831 0.105872 0.458427 0.054348
chr15:59704741-59706175 0.9998 True 8.516943 -0.808251 -0.401216 0.850416 0.042165 0.422472 0.021256

We can now examine these regions to understand what is happening in the data, using various different annotation and enrichment methods. For instance, chr11:60222766-60223569, one of the regions preferentially accessible in cluster 0, is the promoter region of `MS4A1 <>`__, also known as CD20, a known B-cell surface marker, indicating that cluster 0 are probably B-cells.