Python package for calculating TME scores
Project description
TMEImmune
TMEImmune is a Python package that implements the ESTIMATE algorithm, ISTMEscore method, NetBio method, and SIA method. The ESTIMATE and ISTMEscore methods were originally available only in R, and we've ported them to Python for broader accessibility. Additionally, the NetBio and SIA methods, which did not have existing packages, has been manually implemented in Python following the original publications and codes.
Features
- Implementation of the ESTIMATE algorithm for estimating stromal, immune and estimate scores in tumor samples. Estimate tumor purity for Affymetrix platform data.
- Implementation of the ISTMEscore method for improved tumor microenvironment (TME) immune and stromal scoring. The ISTME TME subtypes are also provided.
- Novel implementation of the NetBio and SIA method for comprehensive TME analysis.
- Data pre-processing including normalization and batch correction for both unnormalized read counts and normalized data.
- Performance evaluation for immune checkpoint inhibitor response prediction and survival prognosis.
Installation
You can install the package via the following two commands:
pip install TMEImmune
pip install git+https://github.com/qiluzhou/TMEImmune.git
Usage
Here are some basic usage examples:
# Example 1: Data Normalization
from TMEImmune import data_processing
import pandas as pd
clin = pd.read_csv("data/example_clin.csv", index = 0)
df = data_processing.normalization(path = "data/example_gene.csv", method = 'CPM', batch = clin, batch_col = "CANCER")
# Example 2: Compute TME score
from TMEImmune import TME_score
scores = TME_score.get_score(df, method = ['ESTIMATE', 'ISTME', 'NetBio', 'SIA'])
# Example 3: Performance comparison
from TMEImmune import optimal
outcome = optimal.get_performance(scores, metric = ['ICI', 'survival'], score_name = ['EST_stromal', 'EST_immune',
'IS_immune', 'IS_stromal', 'NetBio', 'SIA'], ICI_col = 'response', surv_col = ['time', 'delta'], df_clin = clin, surv_p = [0.33, 0.66])
License
This project is licensed under the MIT License. See the LICENSE file for more details.
Contact
If you have any questions or feedback, feel free to open an issue on GitHub Issues. We also welcome contributions for integrating new TME scores into our package. If you'd like to propose a method, please attach a link to its introduction in the Github issue, and we will evaluate it accordingly.
Acknowledgements
The ESTIMATE algorithm from Yoshihara et al. The ISTMEscore method from Zeng et al. The NetBio method from Kong et al. The SIA method from Mezheyeuski et al.
Citations
If you use TMEscore in your research, please cite the following papers:
Yoshihara, K., Shahmoradgoli, M., Martínez, E. et al. Inferring tumour purity and stromal and immune cell admixture from expression data. Nat Commun 4, 2612 (2013). https://doi.org/10.1038/ncomms3612
Zeng, Z., Li, J., Zhang, J. et al. Immune and stromal scoring system associated with tumor microenvironment and prognosis: a gene-based multi-cancer analysis. J Transl Med 19, 330 (2021). https://doi.org/10.1186/s12967-021-03002-1
Kong, J., Ha, D., Lee, J., Kim, I., Park, M., Im, S. H., ... & Kim, S. (2022). Network-based machine learning approach to predict immunotherapy response in cancer patients. Nature communications, 13(1), 3703. https://doi.org/10.1038/s41467-022-31535-6
Mezheyeuski, A., Backman, M., Mattsson, J., Martín-Bernabé, A., Larsson, C., Hrynchyk, I., Hammarström, K., Ström, S., Ekström, J., Mauchanski, S., Khelashvili, S., Lindberg, A., Agnarsdóttir, M., Edqvist, P. H., Huvila, J., Segersten, U., Malmström, P. U., Botling, J., Nodin, B., Hedner, C., … Sjöblom, T. (2023). An immune score reflecting pro- and anti-tumoural balance of tumour microenvironment has major prognostic impact and predicts immunotherapy response in solid cancers. EBioMedicine, 88, 104452. https://doi.org/10.1016/j.ebiom.2023.104452
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tmeimmune-1.1.2.tar.gz.
File metadata
- Download URL: tmeimmune-1.1.2.tar.gz
- Upload date:
- Size: 17.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
40577e54565deb06c509eaeecaf5012ed3b32ef9c2174cdba0d05327850f089a
|
|
| MD5 |
151c686411bdcf8f27f2f7cedbe72da0
|
|
| BLAKE2b-256 |
3e2199b637c610d39b0f632ca7ed03843d6e196c6e343b6cb9c7443379f66f59
|
File details
Details for the file TMEImmune-1.1.2-py3-none-any.whl.
File metadata
- Download URL: TMEImmune-1.1.2-py3-none-any.whl
- Upload date:
- Size: 18.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
69fa613dc15a09f4a573d39241f1052718def455ecbf918fb5c570414af9cc89
|
|
| MD5 |
090e46513f3f95734e36ce21b5913906
|
|
| BLAKE2b-256 |
f0d4a99fc4385321aed927bfe58ce3629a882b7749ac2f8f111f48d76b5cb384
|