Skip to content

Commit

Permalink
Added docs parameter explanation
Browse files Browse the repository at this point in the history
  • Loading branch information
Lilly-May committed Apr 29, 2024
1 parent c6488b8 commit 0d977ef
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/yaml_docs/pipeline_integration_yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -436,6 +436,23 @@ Any metrics you may want to plot on all modality UMAPs should be listed under `a

If you want to add any additional plots, simply remove the log file (logs/plot_batch_corrected_umaps.log) and run `panpipes integration make plot_umaps`.


## scib metrics
To assess the unimodal data integration, we use the scib metrics.
The metrics are calculated using the `scib-metrics` package.
The metrics are calculated and stored for each modality separately.

- <span class="parameter">scib:</span> <br>
- <span class="parameter">rna</span> `String`, Optional<br>
Obs column name for the rna modality containing the cell type labels.
If not provided, only a subset of the metrics working without cell type labels will be calculated.
Especially the bio conservation metrics will not be calculated, which also prevents creating the benchmarking plots.
- <span class="parameter">prot</span> `String`, Optional<br>
Obs column name for the prot modality containing the cell type labels.
- <span class="parameter">atac</span> `String`, Optional<br>
Obs column name for the atac modality containing the cell type labels.


## Creating the final object

Leave this final option blank until you have reviewed the results from running `panpipes integration make full`.
Expand Down
1 change: 1 addition & 0 deletions panpipes/panpipes/pipeline_integration/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ plotqc:
#-------------
# scib metrics
#-------------
#Obs columns containing the cell type labels
scib:
rna:
prot:
Expand Down

0 comments on commit 0d977ef

Please sign in to comment.