where gene_expression_matrix is a matrix with genes in rows and samples in columns. The rownames must be
HGNC symbols for human data, or MGI gene symbols for mouse data.
The colnames must be sample names. For human data, the method can be one of
The ESTIMATE algorithm, which computes a score for the tumoral, immune and stromal components and the fraction of tumor purity of a sample, has been implemented.
Finally, certain methods can be used with custom signatures, consisting of either a signature matrix or signature genes
for the cell types of interest. Since the information used to deconvolute the bulk is user-provided, these functions can be
used for different tissues and organisms.
The functions may require different input data formats, related to the requirements of each method. Please refer to their documentation.
The available methods are
Note that, while immunedeconv itself is free (BSD), you may need to obtain a license to use the individual methods. See the table below for more information. If you use this package in your work, please cite both our package and the method(s) you are using.
Sturm G, Finotello F, Petitprez F, Zhang JD, Baumbach J, Fridman WH, List M, Aneichyk T. Comprehensive evaluation of transcriptome-based cell-type quantification methods for immuno-oncology. Bioinformatics. 2019 Jul 15;35(14):i436-i445. doi: 10.1093/bioinformatics/btz363.
If you use immunedeconv for the deconvolution of mouse transcriptomic data, please cite:
Merotto L, Sturm G, Dietrich A, List M, Finotello F. Making mouse transcriptomics deconvolution accessible with immunedeconv. Bioinform Adv. 2024 Feb 28;4(1):vbae032. doi: 10.1093/bioadv/vbae032.
For the mouse/custom-based methods, cite:
Merotto, L., Sturm, G., Dietrich, A., List, M., Finotello, F. (2024). Making mouse transcriptomics deconvolution accessible with immunedeconv, Bioinformatics Advances, Volume 4, Issue 1. https://doi.org/10.1093/bioadv/vbae032
Newman, A. M., Liu, C. L., Green, M. R., Gentles, A. J., Feng, W., Xu, Y., … Alizadeh, A. A. (2015). Robust enumeration of cell subsets from tissue expression profiles. Nature Methods, 12(5), 453–457. https://doi.org/10.1038/nmeth.3337
Becht, E., Giraldo, N. A., Lacroix, L., Buttard, B., Elarouci, N., Petitprez, F., … de Reyniès, A. (2016). Estimating the population abundance of tissue-infiltrating immune and stromal cell populations using gene expression. Genome Biology, 17(1), 218. https://doi.org/10.1186/s13059-016-1070-5
Racle, J., de Jonge, K., Baumgaertner, P., Speiser, D. E., & Gfeller, D. (2017). Simultaneous enumeration of cancer and immune cell types from bulk tumor gene expression data. ELife, 6, e26476. https://doi.org/10.7554/eLife.26476
Yoshihara, K., Shahmoradgoli, M., Martínez, E., Vegesna, R., Kim, H., Torres-Garcia, W., Treviño, V., Shen, H., Laird, P. W., Levine, D. A., Carter, S. L., Getz, G., Stemke-Hale, K., Mills, G. B., & Verhaak, R. G. (2013). Inferring tumour purity and stromal and immune cell admixture from expression data. Nature communications, 4, 2612. https://doi.org/10.1038/ncomms3612
Jiménez-Sánchez, A., Cast, O., & Miller, M. L. (2019). Comprehensive Benchmarking and Integration of Tumor Microenvironment Cell Estimation Methods. Cancer research, 79(24), 6238–6246. https://doi.org/10.1158/0008-5472.CAN-18-3560
Petitprez, F., Levy, S., Sun, C. M., Meylan, M., …, de Reyniès, A. (2020). The murine Microenvironment Cell Population counter method to estimate abundance of tissue-infiltrating immune and stromal cell populations in murine samples using gene expression. Genome medicine, 12(1), 86. https://doi.org/10.1186/s13073-020-00783-w
Altboum, Z., Steuerman, Y., David, E., Barnett-Itzhaki, Z., Valadarsky, L., …, Amit, I. (2014). Digital cell quantification identifies global immune cell dynamics during influenza infection. Molecular systems biology, 10(2), 720. https://doi.org/10.1002/msb.134947
BASE
mouse
free
Varn, F. S., Andrews, E. H., Mullins, D. W., & Cheng, C. (2016). Integrative analysis of breast cancer reveals prognostic haematopoietic activity and patient-specific immune response profiles. Nature communications, 7, 10248. https://doi.org/10.1038/ncomms10248
Comparison of the methods
For a benchmark comparison of the human-based methods, please see our publication.
If you would like to benchmark additional methods, please see our benchmark
pipeline.
Installation
System requirements: R >= 4.1. Only linux is officially supported, but Mac/Windows should work, too.
Bioconda (Linux/MacOS only)
The easiest way to retrieve this package and all its dependencies is to use Anaconda.
The installation typically completes within minutes.
Download Miniconda, if you don’t have a conda installation already.
(Optional) create and activate an environment for deconvolution:
conda will automatically install the package and all dependencies.
You can then open an R instance within the environment and use the package.
Standard R Package
We highly recommend using conda, as it will avoid incompatibilities between
different package versions. That being said, you can also install immunedeconv
as a regular R package in your default R installation. The installation typically completes within 30 minutes, depending
on how many dependency packages need to be compiled.
The easiest way to do so is to use the remotes package, which will automatically download all CRAN, Bioconductor and GitHub dependencies:
an R package for unified access to computational methods for estimating immune cell fractions from bulk RNA sequencing data.
Basic usage
Deconvolution of human data:
Deconvolution of mouse data:
where
gene_expression_matrixis a matrix with genes in rows and samples in columns. The rownames must be HGNC symbols for human data, or MGI gene symbols for mouse data. The colnames must be sample names. For human data, the method can be one ofThe ESTIMATE algorithm, which computes a score for the tumoral, immune and stromal components and the fraction of tumor purity of a sample, has been implemented.
The methods available for the deconvolution of mouse data are
In addition, human-based methods can be used to deconvolute mouse data through the conversion to orthologous gene names
Finally, certain methods can be used with custom signatures, consisting of either a signature matrix or signature genes for the cell types of interest. Since the information used to deconvolute the bulk is user-provided, these functions can be used for different tissues and organisms. The functions may require different input data formats, related to the requirements of each method. Please refer to their documentation. The available methods are
For more detailed usage instructions, see the Documentation:
Available methods, Licenses, Citations
Note that, while immunedeconv itself is free (BSD), you may need to obtain a license to use the individual methods. See the table below for more information. If you use this package in your work, please cite both our package and the method(s) you are using.
If you use immunedeconv for the deconvolution of mouse transcriptomic data, please cite:
For the mouse/custom-based methods, cite:
Comparison of the methods
For a benchmark comparison of the human-based methods, please see our publication. If you would like to benchmark additional methods, please see our benchmark pipeline.
Installation
System requirements: R >= 4.1. Only linux is officially supported, but Mac/Windows should work, too.
Bioconda (Linux/MacOS only)
The easiest way to retrieve this package and all its dependencies is to use Anaconda. The installation typically completes within minutes.
Download Miniconda, if you don’t have a conda installation already.
(Optional) create and activate an environment for deconvolution:
immunedeconvpackagecondawill automatically install the package and all dependencies. You can then open anRinstance within the environment and use the package.Standard R Package
We highly recommend using
conda, as it will avoid incompatibilities between different package versions. That being said, you can also installimmunedeconvas a regular R package in your default R installation. The installation typically completes within 30 minutes, depending on how many dependency packages need to be compiled.The easiest way to do so is to use the
remotespackage, which will automatically download all CRAN, Bioconductor and GitHub dependencies:Credits
This package was originally developed by Gregor Sturm in 2018 at Pieris Pharmaceuticals GmbH in collaboration with Markus List, Tatsiana Aneichyk, and Francesca Finotello. Gregor Sturm continued to support this package while at ICBI (Med Uni Innsbruck). In 2022, this repository moved to the omnideconv organization, a joint effort of the List Lab and Finotello Lab dedicated to improve accessibility of deconvolution methods. At this point Lorenzo Merotto became primary maintainer of the immunedeconv package.