From c64b19ad57b719f97301f2996e1b2c2a9e2a248b Mon Sep 17 00:00:00 2001
From: Mia Croiset <mia.croiset@ens-lyon.fr>
Date: Wed, 20 Sep 2023 10:49:32 +0200
Subject: [PATCH] correct param name in usage docs

---
 docs/hicstuff_usage.md | 10 +++++-----
 docs/usage.md          |  6 ++----
 2 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/docs/hicstuff_usage.md b/docs/hicstuff_usage.md
index 60aad8d..6d0e4a0 100644
--- a/docs/hicstuff_usage.md
+++ b/docs/hicstuff_usage.md
@@ -301,13 +301,13 @@ Name of distance law table plot if hicstuff_distance_plot is true. Default: dist
 --hicstuff_distance_out_plot '[Name of distance law plot file]'
 ```
 
-#### `--filter_pcr`
+#### `--hicstuff_filter_pcr`
 If true, PCR duplicates will be filtered based on genomic positions Pairs where both reads have exactly the same coordinates are considered duplicates and only one of those will be conserved. Default: false
 
 ```bash
 --hicstuff_filter_pcr
 ```
-> :warning: **Warning**: if true, `--filter_pcr_duplicates` **must** be false
+> :warning: **Warning**: if true, `--filter_pcr_picard` **must** be false
 
 #### `--hicstuff_filter_pcr_out_file`
 Name of pair file after PCR filtering. Default: 'valid_idx_pcrfree.pairs'
@@ -316,11 +316,11 @@ Name of pair file after PCR filtering. Default: 'valid_idx_pcrfree.pairs'
 --hicstuff_filter_pcr_out_file '[Name of pcr free pair file]'
 ```
 
-#### `--filter_pcr_duplicates`
+#### `--filter_pcr_picard`
 
-If specified, duplicate reads are filtered using PICARD MarkDuplicate method. If true, `--keep_dups` **must** also be true. Default:'false'
+If specified, duplicate reads are filtered using PICARD MarkDuplicate method. If true, `--hicstuff_filter_pcr` **must** be false. Default:'false'
 
 ```bash
---filter_pcr_duplicates
+--filter_pcr_picard
 ```
 
diff --git a/docs/usage.md b/docs/usage.md
index a32e4b8..1545904 100644
--- a/docs/usage.md
+++ b/docs/usage.md
@@ -381,16 +381,14 @@ If specified, duplicate reads are not discarded before building contact maps.
 --keep_dups
 ```
 
-#### `--filter_pcr_duplicates`
+#### `--filter_pcr_picard`
 
 If specified, duplicate reads are filtered using PICARD MarkDuplicate method. If true, `--keep_dups` **must** also be true. Default:'false'
 
 ```bash
---filter_pcr_duplicates
+--filter_pcr_picard
 ```
 
-> :warning: **Warning**: this option is **not** functional yet with the workflow hicpro. Setting this parameter true will fail your run.
-
 #### `--keep_multi`
 
 If specified, reads that aligned multiple times on the genome are not discarded.
-- 
GitLab