Update help for --dynamic_filter

nf-core · Dec 10, 2024 · ed7e5a6 · ed7e5a6
1 parent 37cc14d
commit ed7e5a6
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/conf/test.config b/conf/test.config
@@ -32,7 +32,7 @@ params {
     multiplet_recovery                = true
     min_size                          = 2
     max_size                          = 100000
-    dynamic_filtering                 = null
+    dynamic_filter                    = null
     compute_polarization              = true
     use_full_bipartite                = true
     colocalization_min_region_count   = 0

diff --git a/conf/test_panel_v2.config b/conf/test_panel_v2.config
@@ -33,7 +33,7 @@ params {
     multiplet_recovery                = true
     min_size                          = 2
     max_size                          = 100000
-    dynamic_filtering                 = nu
+    dynamic_filter                    = null
     compute_polarization              = true
     use_full_bipartite                = true
     colocalization_min_region_count   = 0

diff --git a/nextflow_schema.json b/nextflow_schema.json
@@ -276,7 +276,8 @@
                     "type": "integer"
                 },
                 "dynamic_filter": {
-                    "description": " Enable the estimation of dynamic size filters using a log-rank approach both: estimate both min and max size, min: estimate min size (--min-size), max: estimate max size (--max-size)",
+                    "description": "Enable the estimation of dynamic size filters using a log-rank approach.",
+                    "help_text": "Following options are available:\n- both: estimates both minimum and maximum component size\n- min: estimates the minimum component size (or uses {MINIMUM_N_EDGES_CELL_SIZE} edges, whichever is smallest)\n- max: estimates the maximum component size.\n\nNote that this cannot be set at the same time as `--min-size` or `--max-size`.",
                     "type": "string",
                     "enum": ["both", "min", "max"],
                     "default": "min"