Skip to content

Documents the fastq* options used in htslib's hts.c and sam.c#2123

Merged
daviesrob merged 1 commit into
samtools:developfrom
jkbonfield:fastq_opts
Oct 23, 2024
Merged

Documents the fastq* options used in htslib's hts.c and sam.c#2123
daviesrob merged 1 commit into
samtools:developfrom
jkbonfield:fastq_opts

Conversation

@jkbonfield

Copy link
Copy Markdown
Contributor

These were previously only defined within samtools import, and specified in terms of their associated command line parameters rather than the input and output format options.

Fixes #2121

@daviesrob daviesrob self-assigned this Oct 10, 2024

@daviesrob daviesrob left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few typos need to be fixed. The current ordering looks a bit random - maybe they would be better in alphabetical order? Although I could be persuaded that fastq_barcode is better listed after fastq_casava given the relationship between them.

Comment thread doc/samtools.1 Outdated
Comment thread doc/samtools.1 Outdated
Comment thread doc/samtools.1 Outdated
Comment thread doc/samtools.1 Outdated
These were previously only defined within samtools import, and
specified in terms of their associated command line parameters rather
than the input and output format options.

Fixes samtools#2121
@jkbonfield

Copy link
Copy Markdown
Contributor Author

Updated text. Thanks

@jkbonfield

jkbonfield commented Oct 22, 2024

Copy link
Copy Markdown
Contributor Author

A few typos need to be fixed. The current ordering looks a bit random - maybe they would be better in alphabetical order? Although I could be persuaded that fastq_barcode is better listed after fastq_casava given the relationship between them.

The order was deliberate, in the order they are applied basically.

FASTQ headers have name first, so fastq_name2, then comes the CASAVA string if present, then aux tags. I put fastq_barcode before fastq_aux as it refers to both CASAVA and general aux tags so it fits neatly between the two. Basically I wrote them so if you read them naturally one after the other then they form a sensible ordering which relates to the file format. If you're just trying to look up a specific one, then I suggest searching as frankly you'd need that anyway given the size of the man page.

Edit: I forgot thelast one, fastq_rnum. That's output only. You'll see there is the input only, then input/output and finally output only in that order. To my mind at least that makes sense, but I could see an argument for putting rnum next to name2. It's all arbitrary, but alphabetical is even more arbitrary given there is no real group other than whatever word happened to be used. The only benefit to alphabetical is searching / random access on long lists, but this list is tiny. I'll also refer you to the main man page structure which is by theme, and not alphabetical.

@daviesrob daviesrob merged commit defc2af into samtools:develop Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fastq --import-format-options are not documented in the samtools.1 manual page

3 participants