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

Add an MN:i tag (number of SEQ bases at time of modification tag update). #714

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

Conversation

jkbonfield
Copy link
Contributor

This is used as a sanity check on the validity of the MM and ML tags. It holds the length of SEQ at the time MM and ML were produced and/or updated. The intention is to provide a mechanism to detect hard-clipping has been performed with a tool that is not MM/ML aware.

Fixes #646

@github-actions
Copy link

Changed PDFs as of 4323b3b: SAMtags (diff).

SAMtags.tex Outdated
\item[MZ:i:\tagvalue{length}]
\hfill\\
Tools may edit the {\sf SEQ} sequence data, such as modifying the alignment with hard-clipping.
If the sequence is shrunk in this manner then the base offsets in {\tt MM} and {\tt MM} become invalid unless they are also updated accordingly.
Copy link

Choose a reason for hiding this comment

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

Suggested change
If the sequence is shrunk in this manner then the base offsets in {\tt MM} and {\tt MM} become invalid unless they are also updated accordingly.
If the sequence is shrunk in this manner then the base offsets in {\tt MM} and {\tt ML} become invalid unless they are also updated accordingly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks. Fixed this now

@github-actions
Copy link

github-actions bot commented Apr 6, 2023

Changed PDFs as of f8a9905: SAMtags (diff).

@jmarshall
Copy link
Member

What does the Z stand for?

In #646 (comment), the MZ tag name was just a placeholder: “Add a new tag e.g. MZ:i:<seq_len> […]”. Now that we're proposing adding it to the spec, we should workshop the tag to actually be used.

@jkbonfield
Copy link
Contributor Author

jkbonfield commented Apr 12, 2023

Agreed, it's still obviously up for anyone to propose something better. Starting with M is reasonable as it's then with the others. MN may be better as it's then ML, MM, MN in a clump together for the sorted list of tags? N for Number of bases? Z was tentatively just siZe in my head I guess.

This is used as a sanity check on the validity of the MM and ML tags.
It holds the length of SEQ at the time MM and ML were produced and/or
updated.  The intention is to provide a mechanism to detect
hard-clipping has been performed with a tool that is not MM/ML aware.

Fixes samtools#646
@jkbonfield jkbonfield changed the title Add an MZ:i tag. Add an MN:i tag (number of SEQ bases at time of modification tag update). May 2, 2023
@github-actions
Copy link

github-actions bot commented May 2, 2023

Changed PDFs as of 3aa0ded: SAMtags (diff).

@jkbonfield
Copy link
Contributor Author

As agreed during the last conference call, I renamed MZ to MN. (Mnenomic could be Modification Number of bases?)
I'll update htslib soon too so it's in sync before the next release happens. (The changes there haven't appeared in any release yet.)

jkbonfield added a commit to jkbonfield/htslib that referenced this pull request May 2, 2023
whitwham pushed a commit to samtools/htslib that referenced this pull request May 9, 2023
vasudeva8 pushed a commit to vasudeva8/htslib that referenced this pull request May 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Needs review
Development

Successfully merging this pull request may close these issues.

MM tag and hard clipped alignments
3 participants