Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copy the tag type text from SAM spec to SAMtags (PR #804) #804

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jkbonfield
Copy link
Contributor

SAM section 1.5 clearly defines the standard SAM tag types along with the expanded codes used in the B byte-array type. This text has been copied into the SAMtags document to remove a rather woolly definition there. The text describing lower-case tags has been removed, because this was already discussed in further detail at the end of the SAMtags document (and is itself somewhat woolly when it comes to half-upper half-lower combinations due to the addition of draft tags).

Fixes #798

SAM section 1.5 clearly defines the standard SAM tag types along with the
expanded codes used in the B byte-array type.  This text has been
copied into the SAMtags document to remove a rather woolly definition
there.  The text describing lower-case tags has been removed, because
this was already discussed in further detail at the end of the SAMtags
document (and is itself somewhat woolly when it comes to half-upper
half-lower combinations due to the addition of draft tags).

Fixes samtools#798
Copy link

github-actions bot commented Jan 7, 2025

Changed PDFs as of 7f4af4b: SAMtags (diff).

@zaeleus
Copy link

zaeleus commented Jan 22, 2025

Why not link to § 1.5 "The alignment section: optional fields", rather than duplicating the serialization format here? The introduction notes that this is a companion document, which associates the two together anyway.

Alternatively, you could replace the type codes with generalized types, e.g., i => integer, Z => string, B,I => uint32_t[], etc. This would remove the need to describe the format.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: New items
Development

Successfully merging this pull request may close these issues.

Somewhat unclear references to types in SAMtags
2 participants