Skip to content

Commit

Permalink
Set default clr margin to 1
Browse files Browse the repository at this point in the history
  • Loading branch information
Lilly-May committed Mar 6, 2024
1 parent 69d8a52 commit 5043714
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/yaml_docs/pipeline_preprocess_yml.md
Original file line number Diff line number Diff line change
Expand Up @@ -325,10 +325,10 @@ Whether applying scaling or not is still a matter of debate, as stated in the [L
If you choose to run both (dsb and clr), then 'dsb' is stored in X as default.
For downstream visualisation, you can either specify the layer, or take the default stored in X.

- <span class="parameter">clr_margin</span> `Integer` (0 or 1), Default: 0<br>
- <span class="parameter">clr_margin</span> `Integer` (0 or 1), Default: 1<br>
Parameter for CLR normalisation.
The CLR margin determines whether you normalise per cell (as you would normalise RNA data), or by feature (recommended, due to the variable nature of protein assays).
Hence, CLR margin 0 is recommended for informative qc plots in this pipeline.
Hence, CLR margin 1 is recommended for informative qc plots in this pipeline.
- 0 = normalise row-wise (per cell)
- 1 = normalise column-wise (per feature)

Expand Down
2 changes: 1 addition & 1 deletion panpipes/panpipes/pipeline_preprocess/pipeline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ prot:
# CLR parameters:
# 0 = normalise row-wise (per cell)
# 1 = normalise column-wise (per feature, recommended)
clr_margin: 0
clr_margin: 1

# DSB parameters:
background_obj:
Expand Down

0 comments on commit 5043714

Please sign in to comment.