From 082db14b3a509e88d5178690d118eb963b6403ab Mon Sep 17 00:00:00 2001 From: Mia Croiset <mia.croiset@ens-lyon.fr> Date: Wed, 6 Dec 2023 10:47:11 +0100 Subject: [PATCH] docs add skip_plot_matrix flag --- docs/hicstuff_usage.md | 8 ++++++++ docs/usage.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/docs/hicstuff_usage.md b/docs/hicstuff_usage.md index 28059c9..9a20ce2 100644 --- a/docs/hicstuff_usage.md +++ b/docs/hicstuff_usage.md @@ -234,6 +234,14 @@ Binsize for plotting matrix. Default: 10000 --hicstuff_bin [binsize] ``` +### `--skip_plot_matrix` + +Do not plot matrices. Default: false + +```bash +--skip_plot_matrix +``` + > :warning: **Warning**: Depending of the size of your input, the bin size may not correspond and make the pipeline fail >>10000 is default for human genome. >>For yeast for example you may want to use a smaller bin diff --git a/docs/usage.md b/docs/usage.md index 98188da..0c3e0f9 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -640,6 +640,14 @@ Do not call TADs. Default: false --skip_tads ``` +### `--skip_plot_matrix` + +Do not plot matrices. Default: false + +```bash +--skip_plot_matrix +``` + ### `--skip_multiQC` If defined, the MultiQC report is not generated. Default: false -- GitLab