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 ID subfield to VCF v4.3 test file's structured header #773

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

Conversation

jmarshall
Copy link
Member

@jmarshall jmarshall commented Jun 18, 2024

In VCF v4.3 structured meta-information lines must have an ID subfield. Split the value into identifier-like ID and text Description subfields to demonstrate the structured benefit, though for a non-INFO/FORMAT/etc line there's probably nothing requiring ID's value to be identifier-like. Fixes #772.

This leaves the similar 4.1 and 4.2 files as is, as it is less clear whether ID-less structured headers are merely discouraged there and/or is unspecified and largely left up to implementations — cf #760.

In VCF v4.3 structured meta-information lines must have an ID subfield.
Split the value into identifier-like ID and text Description subfields
to demonstrate the structured benefit, though for a non-INFO/FORMAT/etc
line there's probably nothing requiring ID's value to be identifier-like.
Fixes samtools#772.

This leaves the similar 4.1 and 4.2 files as is, as it is less clear
whether ID-less structured headers are merely discouraged there.
Copy link

@zaeleus zaeleus left a comment

Choose a reason for hiding this comment

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

The fix looks good to me.

This leaves the similar 4.1 and 4.2 files as is, as it is less clear whether ID-less structured headers are merely discouraged there and/or is unspecified and largely left up to implementations — cf #760.

It's not up to implementations if an authoritative example is expected to pass. Leaving them forces parsers to accept such header records, despite the behavior being undefined in those versions.

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

Successfully merging this pull request may close these issues.

vcf: Invalid unstructured header line in VCF 4.3 example complexfile_passed_000.vcf
3 participants