Home

Awesome

Database Python package

CellphoneDB

What is CellphoneDB?

CellphoneDB is a publicly available repository of HUMAN curated receptors, ligands and their interactions paired with a tool to interrogate your own single-cell transcriptomics data (or even bulk transcriptomics data if your samples represent pure populations!).

A distinctive feature of CellphoneDB is that the subunit architecture of either ligands and receptors is taken into account, representing heteromeric complexes accurately. This is crucial, as cell communication relies on multi-subunit protein complexes that go beyond the binary representation used in most databases and studies. CellphoneDB also incorporates biosynthetic pathways in which we use the last representative enzyme as a proxy of ligand abundance, by doing so, we include interactions involving non-peptidic molecules. CellphoneDB includes only manually curated & reviewed molecular interactions with evidenced role in cellular communication.

Documentation

For more details on using CellphoneDB and a more detailed description of the methods, visit the DOCUMENTATION.

Novel features in v5

  1. New python package that can be easily executed in Jupyter Notebook and Collabs.
  2. A scoring methodology to rank interaction based on the expression specificity of the interacting partners.
  3. A CellSign module to leverage interactions based on the activity of the transcription factor downstream the receptor. This module is accompanied by a collection of 211 well described receptor-transcription factor direct relationships.
  4. A new method of querying of CellphoneDB results search_utils.search_analysis_results.
  5. Tutorials to run CellphoneDB (available here)
  6. Improved computational efficiency of method 2 cpdb_statistical_analysis_method.
  7. A new database (cellphonedb-data v5.0) with more manually curated interactions, making up to a total of ~3,000 interactions. This release of CellphoneDB database has three main changes:
    • Integrates new manually reviewed interactions with evidenced roles in cell-cell communication.
    • Includes non-protein molecules acting as ligands.
    • For interactions with a demonstrated signalling directionality, partners have been ordered according (ligand is partner A, receptor partner B).
    • Interactions have been classified within signaling pathways.
    • CellphoneDB no longer imports interactions from external resources. This is to avoid the inclusion of low-confidence interactions.

See updates from previous releases here.

Installing CellphoneDB

We highly recommend using an isolated python environment (as described in steps 1 and 2) using conda or virtualenv but you could of course omit these steps and install via pip immediately.

  1. Create python=>3.8 environment

    • Using conda: conda create -n cpdb python=3.8
    • Using virtualenv: python -m venv cpdb

  2. Activate environment

    • Using conda: source activate cpdb
    • Using virtualenv: source cpdb/bin/activate

  3. Install CellphoneDB pip install cellphonedb

  4. Set up the kernel for the Jupyter notebooks.

    • Install the ipython kernel: pip install -U ipykernel.
    • Add the environment as a jupyter kernel: python -m ipykernel install --user --name 'cpdb'.
    • Open/Start Jupyter and select the created kernel.

  5. Download the database.

NOTE: Works with Python v3.8 or greater. If your default Python interpreter is for v2.x (you can check it with python --version), calls to python/pip should be substituted by python3/pip3.

Running CellphoneDB Methods

Please, activate your environment if you didn't previously

We have created a set of tutorials that can be accessed for each To use the example data, please tutorials and data.

Preparing INPUTS

Preparing your counts input file (mandatory)

Counts file can be a text file or a h5ad (recommended), h5 or a path to a folder containing a 10x output with mtx/barcode/features files. NOTE: Your gene/protein ids must be HUMAN. If you are working with another specie such as mouse, we recommend you to convert the gene ids to their corresponding orthologous.

Preparing your DEGs file (optional, if method degs_analysis)

This is a two columns file indicating which gene is specific or up-regulated in a cell type (see example ). The first column should be the cell type/cluster name (matching those in meta.txt) and the second column the associated gene id. The remaining columns are ignored. We provide notebooks for both Seurat and Scanpy users. It is on you to design a DEG analysis that is appropriate to your research question.

Preparing your microenvironments file (optional, if microenvs_file_path)

This is a two columns file indicating which cell type is in which spatial microenvironment (see example ). CellphoneDB will use this information to define possible pairs of interacting cells (i.e. pairs of clusters co-appearing in a microenvironment).

Preparing your active transcription factor file (optional, if active_tfs_file_path)

This is a two columns file indicating which cell type and which TFs are active (see example). CellphoneDB will use this information to highlight relevant/significant interactions whose downstream TF is active. The information defined in this file (which TFs are active per cell) must be provided by the user.

RUN examples

For more detailed examples refer to our tutorials here.

Example with running the DEG-based method

from cellphonedb.src.core.methods import cpdb_degs_analysis_method

cpdb_results = cpdb_degs_analysis_method.call(
        cpdb_file_path = cellphonedb.zip,
        meta_file_path = test_meta.txt,
        counts_file_path = test_counts.h5ad,
        degs_file_path = degs_file_path,
        counts_data = 'hgnc_symbol',
        active_tfs_file_path = active_tf.txt,
        score_interactions = True,
        microenvs_file_path = microenvs_file_path,
        threshold = 0.1,
        output_path = out_path)

Example with running the statistical method

from cellphonedb.src.core.methods import cpdb_statistical_analysis_method

cpdb_results = cpdb_statistical_analysis_method.call(
        cpdb_file_path = cellphonedb.zip,
        meta_file_path = test_meta.txt,
        counts_file_path = test_counts.h5ad,
        counts_data = 'hgnc_symbol',
        active_tfs_file_path = active_tf.txt,
        microenvs_file_path = microenvs_file_path
        score_interactions = True,
        threshold = 0.1,
        output_path = out_path)

Example without using the statistical method

from cellphonedb.src.core.methods import cpdb_analysis_method

cpdb_results = cpdb_analysis_method.call(
        cpdb_file_path = cellphonedb.zip,
        meta_file_path = test_meta.txt,
        counts_file_path = test_counts.txt,
        counts_data = 'hgnc_symbol',
        score_interactions = True,
        output_path = out_path)

from cellphonedb.src.core.methods import cpdb_analysis_method

cpdb_results = cpdb_analysis_method.call(
        cpdb_file_path = cellphonedb.zip,
        meta_file_path = test_meta.txt,
        counts_file_path = test_counts.h5ad,
        counts_data = 'hgnc_symbol',
        output_path = out_path)

Results are saved as files in output_path and as a dictionary of dataframes in the output variable cpdb_results.

To understand the different analysis and results, please check the results documentation.

Optional Parameters

Optional Method parameters:

~ Optional Method Statistical parameters

Query results

CellphoneDB results can be queried by making use of the search_analysis_results method. This method requires two of the files generated by CellphoneDB significant_means and deconvoluted, optionally interaction_scores can be used to subset interactions by score.

Through this method, users can specify the cell pairs of interest and both; the genes query_genes participating in the interaction and/or the name of the interaction itself query_interactions. This method will search for significant/relevant interactions in which any cell specified in query_cell_types_1 is found to any cell specified in query_cell_types_2. Cell pairs within any of these two lists will not be queried, that is to say, no interaction between cells A and B or C and D will be queried.

from cellphonedb.utils import search_utils

search_results = search_utils.search_analysis_results(
        query_cell_types_1 = ['cell_A', 'cell B'],  
        query_cell_types_2 = ['cell_C', 'cell D'],
        query_genes = ['Gene_1', 'Gene_2', 'Gene_3'], 
        query_interactions = ['interaction_name_1', 'interaction_name_2'],  
        significant_means = cpdb_results['significant_means'],
        deconvoluted = cpdb_results['cpdb_deconvoluted'],
        interaction_scores = cpdb_results['interaction_scores'],
        query_minimum_score = 50,
        query_classifications = ['pathway_A', 'pathway_B'],
        separator = '|',
        long_format = True
)

Examples provided in tutorials.

Plotting results

Currently, CellphoneDB relies on external plotting implementations to represent the results. Examples of the use are provided in the tutorials.

We recommend using tools such as: seaborn, ggplot, or a more specific and tailored implementation such as the @ktplots:

Using different database versions

CellphoneDB databases can be updated from the remote repository through our tool. Furthermore, available versions can be listed and downloaded for use. Please, refer to our tutorials for a comprehensive example.

First, the user must download the database to its preferred directory, once this is done, the user must provide the argument cpdb_file_path to the CellphoneDB method to be executed with the provided version of the database.

The database is downloaded in a zip format along with the input files employed to generate it. These input files can be modified to update the database with new interactions.

CellphoneDB v5 is compatible with database version 4.1.0 or newer.

Listing remote available versions

The command to list available versions from the remote repository is:

from IPython.display import HTML, display
from cellphonedb.utils import db_releases_utils

display(HTML(db_releases_utils.get_remote_database_versions_html()['db_releases_html_table']))

See examples.

Download version

The command to download a version from the remote repository is:

from cellphonedb.utils import db_utils

db_utils.download_database(cpdb_target_dir, cpdb_version)

See examples.

Generating user-specific custom database

A user can generate custom databases and use them. In order to generate a new database, a user can provide his/her own lists.

We recommend first to download CellphoneDB database, move these downloaded files into a new folder and then modify its content to add new interactions. Once this process is completed, the created_db method will create a new database in zip format in the same folder where the inputs are located. Examples of how to download and create the database can be found here example.

To generate such a database the user has to issue this command:

from cellphonedb.utils import db_utils

db_utils.create_db(cpdb_input_dir)

Result database file is generated in the folder out with cellphonedb_{datetime}.zip. Do not change the name of the input files, otherwise CellphoneDB will not recognize them and and error will be thrown.

Contributing to CellphoneDB

CellphoneDB is an open-source project. If you are interested in contributing to this project, please let us know. You can check all project documentation in the docs section

Citing CellphoneDB

The first version of CellphoneDB was originally developed at the Teichmann Lab in the Wellcome Sanger Institute (Cambridge, UK) by Roser Vento-Tormo and Mirjana Efremova. Currently, it is being further developed and supported by the Vento-Tormo Lab (CellphoneDB ≥v3).

If you use CellphoneDB or CellphoneDB-data, please cite our papers: