Skip to content

Commit

Permalink
Fix broadinstitute#1081. Make --USE_SEQUENTIAL_FASTQS help message mo…
Browse files Browse the repository at this point in the history
…re user friendly in FastqToSam.java

 - Issue broadinstitute#1081 raised that help message for FastqToSam.java's --USE_SEQUENTIAL_FASTQS was not very intuititive.

 - Updated help message with more explicit usage (specific text on how to use the option and example commands).
  • Loading branch information
nrockweiler committed Jun 12, 2023
1 parent 4527d6d commit e1d6aad
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions src/main/java/picard/sam/FastqToSam.java
Original file line number Diff line number Diff line change
Expand Up @@ -161,17 +161,17 @@ public class FastqToSam extends CommandLineProgram {
@Argument(shortName="F2", doc="Input fastq file (optionally gzipped) for the second read of paired end data.", optional=true)
public PicardHtsPath FASTQ2;

@Argument(doc="Use sequential fastq files with the suffix <prefix>_###.fastq or <prefix>_###.fastq.gz." +
"The files should be named:\n" +
@Argument(doc="Use sequential fastq files with the suffix <prefix>_###.fastq[.qz]." +
" The files should be named:\n" +
" <prefix>_001.<extension>, <prefix>_002.<extension>, ..., <prefix>_XYZ.<extension>\n" +
" The base files should be:\n" +
" <prefix>_001.<extension>\n" +
" An example would be:\n" +
"Use the *first* file for the --FASTQ argument, e.g., --FASTQ <prefix>_001.<extension>.\n" +
"If paired end, use the *first* read2 file for the --FASTQ2 argument, e.g., <R2_prefix>_001.<extension>.\n" +
"Example: combine and convert 4 single end fastqs with filenames:\n" +
" RUNNAME_S8_L005_R1_001.fastq\n" +
" RUNNAME_S8_L005_R1_002.fastq\n" +
" RUNNAME_S8_L005_R1_003.fastq\n" +
" RUNNAME_S8_L005_R1_004.fastq\n" +
"RUNNAME_S8_L005_R1_001.fastq should be provided as FASTQ.", optional=true)
"Run command with --FASTQ RUNNAME_S8_L005_R1_001.fastq --USE_SEQUENTIAL_FASTQS true", optional=true)
public boolean USE_SEQUENTIAL_FASTQS = false;

@Argument(shortName="V", doc="A value describing how the quality values are encoded in the input FASTQ file. " +
Expand Down

0 comments on commit e1d6aad

Please sign in to comment.