Palantir for modeling continuous cell state and cell fate choices in single cell data
Project description
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
Palantir has been implemented in Python3 and can be installed using:
Using pip
pip install palantir
Using conda, mamba, or micromamba from the bioconda channel
You can also install Palantir via conda, mamba, or micromamba from the bioconda channel:
Using conda
conda install -c conda-forge -c bioconda palantir
Using mamba
mamba install -c conda-forge -c bioconda palantir
Using micromamba
micromamba install -c conda-forge -c bioconda palantir
These methods ensure that all dependencies are resolved and installed efficiently.
Usage
A tutorial on Palantir usage and results visualization for single cell RNA-seq data can be found in this notebook: https://github.com/dpeerlab/Palantir/blob/master/notebooks/Palantir_sample_notebook.ipynb
More tutorials and a documentation of all the Palantir components can be found here: https://palantir.readthedocs.io
Processed data and metadata
scanpy anndata
objects are available for download for the three replicates generated in the manuscript:
This notebook details how to use the data in Python
and R
:
https://github.com/dpeerlab/Palantir/blob/master/notebooks/manuscript_data.ipynb
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.3.4
- avoid devision by zero in
select_branch_cells
for very small datasets - make branch selection robust against NaNs
- do not plot unclustered trends (NaN cluster) in
plot_gene_trend_clusters
Version 1.3.3
- optional progress bar with
progress=True
inpalantir.utils.run_local_variability
- avoid NaN in local variablility output
- compatibility with
scanpy>=1.10.0
Version 1.3.2
- require
python>=3.8
- implement CI for testing
- fixes for edge cases discoverd through extended testing
- implement
plot_trajectory
function to show trajectory on the umap - scale pseudotime to unit intervall in anndata
Version 1.3.1
- implemented
palantir.plot.plot_stats
to plot arbitray cell-wise statistics as x-/y-positions. - reduce memory usgae of
palantir.presults.compute_gene_trends
- removed seaborn dependency
- refactor
run_diffusion_maps
to split outcompute_kernel
anddiffusion_maps_from_kernel
- remove unused dependencies
tables
,Cython
,cmake
, andtzlocal
. - fixes in
run_pca
(return correct projections and do not use too many components)
Version 1.3.0
New Features
- Enable an AnnData-centric workflow for improved usability and interoperability with other single-cell analysis tools.
- Introduced new utility functions
palantir.utils.early_cell
To automate fining an early cell based on cell type and diffusion components.palantir.utils.find_terminal_states
To automate finding terminal cell states based on cell type and diffusion components.palantir.presults.select_branch_cells
To find cells associated to each branch based on fate probability.palantir.plot.plot_branch_selection
To inspect the cell to branch association.palantir.utils.run_local_variability
To compute local gene expression variability.palantir.utils.run_density
A wrapper for mellon.DensityEstimator.palantir.utils.run_density_evaluation
Evaluate computed density on a different dataset.palantir.utils.run_low_density_variability
. To aggregate local gene expression variability in low density.palantir.plot.plot_branch
. To plot branch-selected cells over pseudotime in arbitrary y-postion and coloring.palantir.plot.plot_trend
. To plot the gene trend ontop ofpalantir.plot.plot_branch
.
- Added input validation for better error handling and improved user experience.
- Expanded documentation within docstrings, providing additional clarity for users and developers.
Enhancements
- Updated tutorial notebook to reflect the new workflow, guiding users through the updated processes.
- Implemented gene trend computation using Mellon, providing more robust and efficient gene trend analysis.
- Enable annotation in
palantir.plot.highight_cells_on_umap
.
Changes
- Replaced PhenoGraph dependency with
scanpy.tl.leiden
for gene trend clustering. - Deprecated the
run_tsne
,determine_cell_clusters
, andplot_cell_clusters
functions. Use corresponding implementations from Scanpy, widely used single-cell analysis library and direct dependecy of Palantir. - Rename
palantir.plot.highight_cells_on_tsne
topalantir.plot.highight_cells_on_umap
- Depend on
anndata>=0.8.0
to avoid issues writing dataframes inad.obsm
.
Fixes
- Addressed the issue of variability when reproducing results (issue#64), enhancing the reproducibility and reliability of Palantir.
Version 1.1.0
- Replaced rpy2 with pyGAM for computing gene expression trends.
- Updated tutorial and plotting functions
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file palantir-1.3.4.tar.gz
.
File metadata
- Download URL: palantir-1.3.4.tar.gz
- Upload date:
- Size: 36.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 467aa9fbf9f6d2df2b3fe7ad148ad1675becf3682744b837b70941547bccbbb0 |
|
MD5 | 045c204d658b85b5c241d0742fce507e |
|
BLAKE2b-256 | 5b9400c0e508bf201c9d10b8b301787d85b8be7f0d6773815ec338b1f80bf474 |
File details
Details for the file palantir-1.3.4-py3-none-any.whl
.
File metadata
- Download URL: palantir-1.3.4-py3-none-any.whl
- Upload date:
- Size: 51.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e7c72586e54f5ee3b8c2546d6a32f6947709d8185676d24d4982aab2a82dccc2 |
|
MD5 | a9a1c4743eb87e28c8c7341be74f76d9 |
|
BLAKE2b-256 | 742c48f1b0038fbfbea6d8ba02ba1c6c72711bcbadd0a55f4ced5cd171ff57a1 |