From 40ccbe37db0a9172f605d7506f2c9a16978483ec Mon Sep 17 00:00:00 2001 From: Fabiola Curion Date: Wed, 24 Apr 2024 09:20:46 +0200 Subject: [PATCH] Update integration_methods.md --- docs/usage/integration_methods.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/usage/integration_methods.md b/docs/usage/integration_methods.md index eac37f21..84d16e82 100644 --- a/docs/usage/integration_methods.md +++ b/docs/usage/integration_methods.md @@ -9,14 +9,15 @@ # Integration methods implemented in panpipes -The panpipes integration pipeline implements a variety of tools to batch correct individual modalities and/or integrate across modalities to produce a reduced dimension representation of the dataset.
-There are different tools available for each modality such as RNA (also referred to as GEX), PROT (can be referred to as ADT) and ATAC which can be run as required before running `panpipes integration make merge_batch_correction` -to create the final object with the reduced dimension represented.
+The panpipes integration workflow implements a variety of tools to batch correct individual modalities and/or integrate across modalities to produce a reduced dimension representation of the dataset.
+There are different tools available for each modality: RNA (also referred to as GEX), PROT (can be referred to as ADT) and ATAC which can be integrated into any preferred combination customising the integration workflow configuration file and running `panpipes integration make full`. After the results of the integration are inspected, the final object is created with `panpipes integration make merge_integration`.
The ideal way to run `panpipes integration` is to use the output `MuData`file from `panpipes preprocess` since it will already be in the required format. However, if using independent MuData the object should contain normalised data in the X slot of each modality, a ‘raw_counts’ layer in each modality, and a sample_id column in each slot of the obs and the outer obs. -The following table describes the different methods of batch correction available and their specificities: +Users can choose which integration method they want to apply based on their experiment, their experience with the tools or available benchmarks: we link all the relevant resources below. +We don't believe in "one method fits all", we instead offer the user a framework to run multiple tools efficiently, keeping a record of the hyperparameters in the configuration files, so you can safely re-run your analysis and share it with collaborators. We will continue to update the integration methods offered in `panpipes` and we invite you to contribute yours! +The following table describes the different methods currently supported and their specificities: | Method | type of integration | modalities | code | references | benchmarks paper | |-----------|-----------------------------|-----------------|-----------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------| @@ -28,3 +29,5 @@ The following table describes the different methods of batch correction availabl | totalVI | multimodal | prot, rna | [totalVI](https://github.com/scverse/scvi-tools) | [Gayoso  et al. 2021](https://pubmed.ncbi.nlm.nih.gov/33589839/) | [Makrodimitris et al 2024](https://academic.oup.com/bib/article/25/1/bbad416/7450271) | | MOFA | multimodal | rna, atac, prot | [MOFA](https://github.com/bioFAM/mofapy2) | [Argelaguet et al 2020](https://genomebiology.biomedcentral.com/articles/10.1186/s13059-020-02015-1) | [Lee, Kaestner, and Li 2023](https://genomebiology.biomedcentral.com/articles/10.1186/s13059-023-03073-x) | | WNN | multimodal | rna, atac, prot | [WNN](https://muon.readthedocs.io/en/latest/api/generated/muon.pp.neighbors.html) | [Hao et al 2021](https://pubmed.ncbi.nlm.nih.gov/34062119/) | [Lee, Kaestner, and Li 2023](https://genomebiology.biomedcentral.com/articles/10.1186/s13059-023-03073-x) | + +