Skip to content

Commit

Permalink
Merge branch 'main' into kra-logging
Browse files Browse the repository at this point in the history
  • Loading branch information
kevinrue committed Apr 22, 2024
2 parents 246ef5c + 73b437e commit 9328dc9
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/workflows/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The panpipes integration pipeline implements a variety of tools to batch correct

![integration_flowchart](../img/integration_coloured.drawio.png)

The flowchart indicates which tools are available for each modality out of RNA (also referred to as GEX), PROT (also referred to as ADT) and ATAC. You can run as many of these tools as you choose and then you can run `panpipes integration make merge_batch_correction` to create a final object containing one reduced dimension representation and one nearest neighbor graph per modality. This can be used as input to the clustering pipeline.
The flowchart indicates which tools are available for each modality out of RNA (also referred to as GEX), PROT (also referred to as ADT) and ATAC. You can run as many of these tools as you choose and then you can run `panpipes integration make merge_integration` to create a final object containing one reduced dimension representation and one nearest neighbor graph per modality. This can be used as input to the clustering pipeline.

## Steps to run

Expand All @@ -16,7 +16,7 @@ The flowchart indicates which tools are available for each modality out of RNA (
3. Use pipeline outputs to decide on the best batch correction method
4. Edit the integration pipeline yml with your preferred batch
correction
5. Run `panpipes integration make merge_correction`
5. Run `panpipes integration make merge_integration`

## Expected structure of MuData object

Expand Down
4 changes: 3 additions & 1 deletion tests/integration_1/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ rna:
# SCVI args
#-----------------------------
scvi:
seed: 1492
exclude_mt_genes: True
mt_column: mt
model_args:
Expand Down Expand Up @@ -217,7 +218,7 @@ multimodal:
# this is a minimal set of parameters that will be expected
# you can add any other param from the tutorials and they will
# be parsed alongside the others

seed: 1492
# totalvi will run on rna and prot
modalities: rna,prot
exclude_mt_genes: True
Expand All @@ -237,6 +238,7 @@ multimodal:
# you can add any other param from the tutorials and they will
# be parsed alongside the others
# leave arguments blank for default
seed: 1492
lowmem: True
# Set lowmem to True will subset the atac to the top 25k HVF.
# This is to deal with concatenation of atac,rna on large datasets which at the moment is suboptimally required by scvitools.
Expand Down
4 changes: 3 additions & 1 deletion tests/integration_2/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ rna:
# SCVI args
#-----------------------------
scvi:
seed: 1492
exclude_mt_genes: True
mt_column: mt
model_args:
Expand Down Expand Up @@ -217,7 +218,7 @@ multimodal:
# this is a minimal set of parameters that will be expected
# you can add any other param from the tutorials and they will
# be parsed alongside the others

seed: 1492
# totalvi will run on rna and prot
modalities: rna,prot
exclude_mt_genes: True
Expand All @@ -237,6 +238,7 @@ multimodal:
# you can add any other param from the tutorials and they will
# be parsed alongside the others
# leave arguments blank for default
seed: 1492
lowmem: True
# Set lowmem to True will subset the atac to the top 25k HVF.
# This is to deal with concatenation of atac,rna on large datasets which at the moment is suboptimally required by scvitools.
Expand Down

0 comments on commit 9328dc9

Please sign in to comment.