diff --git a/docs/yaml_docs/pipeline_clustering_yml.md b/docs/yaml_docs/pipeline_clustering_yml.md index d388d0c5..00d6df47 100644 --- a/docs/yaml_docs/pipeline_clustering_yml.md +++ b/docs/yaml_docs/pipeline_clustering_yml.md @@ -191,13 +191,16 @@ Prefix for the sample that comes out of the filtering/ preprocessing steps of th Options include louvain or leiden. ## Parameters for finding marker genes -If pseudo_suerat is set to false then we run [scanpy](https://scanpy.readthedocs.io/en/stable/generated/scanpy.tl.rank_genes_groups.html). -When pseudo_seurat is set to true then a python implementation of Suerat runs (Seurat::FindMarkers written by CRG) + +In this part of the analysis we define parameters to run marker analysis. +By default, pseudo_seurat is set to False, and we run [scanpy.tl.rank_genes_groups](https://scanpy.readthedocs.io/en/stable/generated/scanpy.tl.rank_genes_groups.html). +When pseudo_seurat is set to True then a [python implementation](https://github.com/DendrouLab/panpipes/blob/main/panpipes/python_scripts/run_find_markers_multi.py) of `Seurat:::FindMarkers` is run - markerspecs:
- rna:
- run `Boolean`, Default: True
- layer `String`, Default: logged_counts
+ Which layer stores counts for differential expression test. - method `String`, Default: t-test_overestim_var
Options include: ‘logreg’, ‘t-test’, ‘wilcoxon’, ‘t-test_overestim_var’ - mincels `Integer`, Default: t-10
@@ -211,7 +214,7 @@ When pseudo_seurat is set to true then a python implementation of Suerat runs (S - prot:
- run `Boolean`, Default: True
- layer `String`, Default: clr
- Can specify an array to compute in parallel: clr, dsb + Which layer stores counts for differential expression test. - mincels `Integer`, Default: t-10
If the number of clusters contains less than the number of cells maker analysis is not necessary. - method `String`, Default: wilcoxon
@@ -224,6 +227,7 @@ When pseudo_seurat is set to true then a python implementation of Suerat runs (S - atac:
- run `Boolean`, Default: False
- layer `String`, Default: logged_counts
+ Which layer stores counts for differential expression test. Options include logged_counts, signac_norm , and logTF_norm,logIDF_norm - mincels `Integer`, Default: t-10
If the number of clusters contains less than the number of cells maker analysis is not necessary. @@ -231,9 +235,9 @@ When pseudo_seurat is set to true then a python implementation of Suerat runs (S Options include: ‘logreg’, ‘t-test’, ‘wilcoxon’, ‘t-test_overestim_var’ - pseudo_seurat `Boolean`, Default: False
- minpct `Float`, Default: 0.1
- This parameter only matters if pseudo_seurat is set to True + This parameter is mandatory if pseudo_seurat is set to True - threshuse `Float`, Default: 0.25
- This parameter only matters if pseudo_seurat is set to True + This parameter is mandatory if pseudo_seurat is set to True - multimodal:
@@ -243,9 +247,9 @@ When pseudo_seurat is set to true then a python implementation of Suerat runs (S Options include: ‘logreg’, ‘t-test’, ‘wilcoxon’, ‘t-test_overestim_var’ - pseudo_seurat `Boolean`, Default: False
- minpct `Float`, Default: 0.1
- This parameter only matters if pseudo_seurat is set to True + This parameter is mandatory if pseudo_seurat is set to True - threshuse `Float`, Default: 0.25
- This parameter only matters if pseudo_seurat is set to True + This parameter is mandatory if pseudo_seurat is set to True - spatial: