Skip to content

Commit da4d125

Browse files
unified options for summary for pmd, hmr, and uniq
1 parent 3dbcb41 commit da4d125

File tree

6 files changed

+9
-9
lines changed

6 files changed

+9
-9
lines changed

docs/content/hmr.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ to filering candidate HMRs. This parameter is typically only used for
172172
testing (default: 408).
173173

174174
```txt
175-
-summary
175+
-S, -summary
176176
```
177177
Write the analysis summary to this file. The summary is not
178-
reported unless a file is specified here.
178+
reported unless a file is specified here. This option is correct as of v1.4.0.

docs/content/pmd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,8 +188,8 @@ Write the trained parameters to this file.
188188
Specify a random seed value.
189189

190190
```txt
191-
-summary
191+
-S, -summary
192192
```
193193
Write the analysis summary to this file. The summary is not
194-
reported unless a file is specified here.
194+
reported unless a file is specified here. This option is correct as of v1.4.0.
195195

docs/content/uniq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,10 @@ most helpful when the input and output are both BAM, where the threads
4949
can really speed things up.
5050

5151
```txt
52-
-S, -stats
52+
-S, -summary
5353
```
5454
Save statistics on duplication rates to this file. The statistics are not
55-
reported unless a file is specified here.
55+
reported unless a file is specified here. This option is correct as of v1.4.0.
5656

5757
```txt
5858
-hist

src/analysis/hmr.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ main_hmr(int argc, const char **argv) {
452452
opt_parse.add_opt("params-out", 'p', "write HMM parameters to this "
453453
"file (default: none)", false, params_out_file);
454454
opt_parse.add_opt("seed", 's', "specify random seed", false, rng_seed);
455-
opt_parse.add_opt("summary", '\0', "write summary output here", false,
455+
opt_parse.add_opt("summary", 'S', "write summary output here", false,
456456
summary_file);
457457
opt_parse.set_show_defaults();
458458
vector<string> leftover_args;

src/analysis/pmd.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1168,7 +1168,7 @@ main_pmd(int argc, const char **argv) {
11681168
opt_parse.add_opt("posteriors-out", 'r',
11691169
"write out posterior probabilities in methcounts format",
11701170
false, posteriors_out_prefix);
1171-
opt_parse.add_opt("summary", '\0',
1171+
opt_parse.add_opt("summary", 'S',
11721172
"write summary output here",
11731173
false, summary_file);
11741174
opt_parse.add_opt("params-out", 'p', "write HMM parameters to this file",

src/utils/uniq.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ main_uniq(int argc, const char **argv) {
286286
"sorted mapped reads",
287287
"<in-file> [out-file]", 2);
288288
opt_parse.add_opt("threads", 't', "number of threads", false, n_threads);
289-
opt_parse.add_opt("stats", 'S', "statistics output file", false, statfile);
289+
opt_parse.add_opt("summary", 'S', "statistics output file", false, statfile);
290290
opt_parse.add_opt("add-count", 'a', "add duplicate counts to reads", false,
291291
add_dup_count);
292292
opt_parse.add_opt("hist", '\0',

0 commit comments

Comments
 (0)