palantir

Palantir for modeling continuous cell state and cell fate choices in single cell data


Keywords
cell-fate-transitions, differentiation, diffusion-maps, dimensionality-reduction, manifold-learning, markov-chain, scrna-seq, scrna-seq-analysis, single-cell-genomics, trajectory-generation
License
MIT
Install
pip install palantir==1.0.0

Documentation

Palantir

Palantir is an algorithm to align cells along differentiation trajectories. Palantir models differentiation as a stochastic process where stem cells differentiate to terminally differentiated cells by a series of steps through a low dimensional phenotypic manifold. Palantir effectively captures the continuity in cell states and the stochasticity in cell fate determination. Palantir has been designed to work with multidimensional single cell data from diverse technologies such as Mass cytometry and single cell RNA-seq.

Installation and dependencies

  1. Palantir has been implemented in Python3 and can be installed using:

     $> pip install PhenoGraph
     $> pip install palantir
    
  2. Palantir depends on a number of python3 packages available on pypi and these dependencies are listed in setup.py

    All the dependencies will be automatically installed using the above commands

  3. To uninstall:

     $> pip uninstall palantir
    
  4. If you would like to determine gene expression trends, please install R programming language and the R package GAM . You will also need to install the rpy2 module using

     $> pip install .['PLOT_GENE_TRENDS']
         OR,
     $> pip install rpy2
    

    In case of compiler error during installation of rpy2, try to link your compiler in env. Example:

     $> env CC=/usr/local/Cellar/gcc/xxx/bin/gcc-x pip install .['PLOT_GENE_TRENDS']
    

    where x should be replaced with the version numbers

  5. Palantir can also be used with Scanpy. It is fully integrated into Scanpy, and can be found under Scanpy's external modules (link)

Usage

A tutorial on Palantir usage and results visualization for single cell RNA-seq data can be found in this notebook: http://nbviewer.jupyter.org/github/dpeerlab/Palantir/blob/master/notebooks/Palantir_sample_notebook.ipynb

Processed data and metadata

scanpy anndata objects are available for download for the three replicates generated in the manuscript: Rep1, Rep2, Rep3

Each object has the following elements

  • .X: Filtered, normalized and log transformed count matrix
  • .raw: Filtered raw count matrix
  • .obsm['MAGIC_imputed_data']: Imputed count matrix using MAGIC
  • .obsm['tsne']: tSNE maps presented in the manuscript generated using scaled diffusion components as inputs
  • .obs['clusters']: Clustering of cells
  • .obs['palantir_pseudotime']: Palantir pseudo-time ordering
  • .obs['palantir_diff_potential']: Palantir differentation potential
  • .obsm['palantir_branch_probs']: Palantir branch probabilities
  • .uns['palantir_branch_probs_cell_types']: Column names for branch probabilities
  • .uns['ct_colors']: Cell type colors used in the manuscript
  • .uns['cluster_colors']: Cluster colors used in the manuscript
  • .varm['mast_diff_res_pval']: MAST p-values for differentially expression in each cluster compared to others
  • .varm['mast_diff_res_statistic']: MAST statistic for differentially expression in each cluster compared to others
  • .uns['mast_diff_res_columns']: Column names for the differential expression results

Comparison to trajectory detection algorithms

Notebooks detailing the generation of results comparing Palantir to trajectory detection algorithms are available here

Citations

Palantir manuscript is available from Nature Biotechnology. If you use Palantir for your work, please cite our paper.

    @article{Palantir_2019,
            title = {Characterization of cell fate probabilities in single-cell data with Palantir},
            author = {Manu Setty and Vaidotas Kiseliovas and Jacob Levine and Adam Gayoso and Linas Mazutis and Dana Pe'er},
            journal = {Nature Biotechnology},
            year = {2019},
            month = {march},
            url = {https://doi.org/10.1038/s41587-019-0068-4},
            doi = {10.1038/s41587-019-0068-4}
    }

Release Notes

Version 1.0.0

  • A fix to issue#41
  • A fix to issue#42
  • Revamped tutorial with support for Anndata and force directed layouts

Version 0.2.6

Version 0.2.5

  • A fix related to issue#28. When identifying terminal states, duplicate values were generated instead of unique ones.