Skip to content

Commit a9896e6

Browse files
committed
upd help
1 parent 4fce4bb commit a9896e6

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

help.go

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,8 @@ func helpFunc(cmd *cobra.Command, args []string) {
4141
bold(getColorizedLogo()+" phredsort headersort - Sorts sequences using header quality metrics"),
4242
bold(yellow("Description:")),
4343
bold(yellow("Flags:")),
44-
cyan("-i, --in")+" <string> : Input FASTA/FASTQ file (required)",
45-
cyan("-o, --out")+" <string> : Output FASTA/FASTQ file (required)",
44+
cyan("-i, --in")+" <string> : Input FASTA/FASTQ file (default: stdin)",
45+
cyan("-o, --out")+" <string> : Output FASTA/FASTQ file (default: stdout)",
4646
cyan("-s, --metric")+" <string> : Header metric to use (avgphred, maxee, meep, lqcount, lqpercent) (default, 'avgphred')",
4747
cyan("-a, --ascending")+" <bool> : Sort in ascending order of the header metric (default, false)",
4848
cyan("-m, --minqual")+" <float> : Minimum header metric value for filtering (optional)",
@@ -83,8 +83,8 @@ func helpFunc(cmd *cobra.Command, args []string) {
8383
bold(getColorizedLogo()+" phredsort sort - Sorts FASTQ based on computed quality metrics"),
8484
bold(yellow("Description:")),
8585
bold(yellow("Flags:")),
86-
cyan("-i, --in")+" <string> : Input FASTQ file (required, use '-' for stdin)",
87-
cyan("-o, --out")+" <string> : Output FASTQ file (required, use '-' for stdout)",
86+
cyan("-i, --in")+" <string> : Input FASTQ file (default: stdin)",
87+
cyan("-o, --out")+" <string> : Output FASTQ file (default: stdout)",
8888
cyan("-s, --metric")+" <string> : Quality metric (avgphred, maxee, meep, lqcount, lqpercent) (default, 'avgphred')",
8989
cyan("-m, --minqual")+" <float> : Minimum quality threshold for filtering (optional)",
9090
cyan("-M, --maxqual")+" <float> : Maximum quality threshold for filtering (optional)",
@@ -95,7 +95,7 @@ func helpFunc(cmd *cobra.Command, args []string) {
9595
cyan("-v, --version")+" : Show version information",
9696
bold(yellow("Examples:")),
9797
cyan("phredsort sort --metric avgphred --in input.fq.gz --out output.fq.gz"),
98-
cyan("cat input.fq | phredsort sort --compress 0 -i - -o - > sorted.fq"),
98+
cyan("cat input.fq | phredsort sort --compress 0 > sorted.fq"),
9999
)
100100
return
101101
case "nosort":
@@ -123,15 +123,15 @@ func helpFunc(cmd *cobra.Command, args []string) {
123123
bold(getColorizedLogo()+" phredsort nosort - Estimates FASTQ quality without sorting"),
124124
bold(yellow("Description:")),
125125
bold(yellow("Flags:")),
126-
cyan("-i, --in")+" <string> : Input FASTQ file (required, use '-' for stdin)",
127-
cyan("-o, --out")+" <string> : Output FASTQ file (required, use '-' for stdout)",
126+
cyan("-i, --in")+" <string> : Input FASTQ file (default: stdin)",
127+
cyan("-o, --out")+" <string> : Output FASTQ file (default: stdout)",
128128
cyan("-s, --metric")+" <string> : Quality metric (avgphred, maxee, meep, lqcount, lqpercent) (default, 'avgphred')",
129129
cyan("-m, --minqual")+" <float> : Minimum quality threshold for filtering (optional)",
130130
cyan("-M, --maxqual")+" <float> : Maximum quality threshold for filtering (optional)",
131131
cyan("-p, --minphred")+" <int> : Quality threshold for 'lqcount' and 'lqpercent' metrics (default, 15)",
132132
bold(yellow("Examples:")),
133133
cyan("phredsort nosort --metric avgphred --in input.fq.gz --out output.fq.gz"),
134-
cyan("cat input.fq | phredsort nosort --metric maxee --maxqual 1 -i - -o - > output.fq"),
134+
cyan("cat input.fq | phredsort nosort --metric maxee --maxqual 1 > output.fq"),
135135
)
136136
return
137137
}
@@ -166,21 +166,21 @@ func helpFunc(cmd *cobra.Command, args []string) {
166166
%s
167167
168168
%s
169-
# File-based mode (reads from a file, lower memory usage)
169+
# Sort by average Phred score (file-based)
170170
%s
171171
172-
# Stdin-based mode (reads from stdin, higher memory usage)
172+
# Sort using stdin/stdout (piping)
173173
%s
174174
175175
# Remove sequences with average Phred quality score below 20,
176176
# add several quality metrics to sequence headers
177177
%s
178178
179-
# Sort sequences using pre-computed quality scores (stored in headers)
179+
# Sort using pre-computed quality scores from headers
180180
# (e.g., ">seq1 maxee=1 avgphred=15.5" or ">seq1;maxee=1;avgphred=15.5")
181181
%s
182182
183-
# Estimate quality metrics without sorting, add quality metrics to headers, and filter sequences
183+
# Estimate quality without sorting, filter and annotate
184184
%s
185185
186186
%s
@@ -195,8 +195,8 @@ func helpFunc(cmd *cobra.Command, args []string) {
195195
cyan("lqcount")+" : number of bases below quality threshold (default, 15)",
196196
cyan("lqpercent")+" : percentage of bases below quality threshold",
197197
bold(yellow("Flags:")),
198-
cyan("-i, --in")+" <string> : Input FASTQ file (required, use '-' for stdin)",
199-
cyan("-o, --out")+" <string> : Output FASTQ file (required, use '-' for stdout)",
198+
cyan("-i, --in")+" <string> : Input FASTQ file (default: stdin)",
199+
cyan("-o, --out")+" <string> : Output FASTQ file (default: stdout)",
200200
cyan("-s, --metric")+" <string> : Quality metric (avgphred, maxee, meep, lqcount, lqpercent) (default, 'avgphred')",
201201
cyan("-m, --minqual")+" <float> : Minimum quality threshold for filtering (optional)",
202202
cyan("-M, --maxqual")+" <float> : Maximum quality threshold for filtering (optional)",
@@ -212,10 +212,10 @@ func helpFunc(cmd *cobra.Command, args []string) {
212212
cyan("headersort")+" : Sort sequences using pre-computed quality scores in headers",
213213
bold(yellow("Usage examples:")),
214214
cyan("phredsort --metric avgphred --in input.fq.gz --out output.fq.gz"),
215-
cyan("cat input.fq | phredsort --compress 0 -i - -o - > sorted.fq"),
215+
cyan("cat input.fq | phredsort --compress 0 > sorted.fq"),
216216
cyan("phredsort -i inp.fq.gz -o out.fq.gz --metric avgphred --minqual 20 --header avgphred,maxee,lqpercent,length"),
217217
cyan("phredsort headersort -i inp.fq.gz -o out.fq.gz --metric maxee"),
218-
cyan("phredsort nosort --metric maxee --maxqual 1 --header maxee -i - -o - > output.fq"),
218+
cyan("cat input.fq | phredsort nosort --metric maxee --maxqual 1 --header maxee > output.fq"),
219219
bold(yellow("More information:")),
220220
)
221221
}

0 commit comments

Comments
 (0)