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

Remove validation of VCF Header line field order? #1610

Open
tfenne opened this issue May 27, 2022 · 1 comment
Open

Remove validation of VCF Header line field order? #1610

tfenne opened this issue May 27, 2022 · 1 comment

Comments

@tfenne
Copy link
Member

tfenne commented May 27, 2022

@lbergelson, @droazen and anyone else who may be interested. Following the discussion in samtools/hts-specs#642 would there be support for (or any objections to) a PR that eliminated the validation of ordering of fields within a given VCF header line?

This issue came up because a[n old] version of one of the GATK's SV tools produces this header line:

##INFO=<ID=END2,Type=Integer,Number=1,Description="Position of breakpoint on CHR2">

instead of the more common:

##INFO=<ID=END2,Number=1,Type=Integer,Description="Position of breakpoint on CHR2">

The discussion on the spec issue hasn't led to a PR yet but there seems to be consensus on clarifying the language to make it clear that there is no required ordering of fields within a single header line. I'm not really sure why HTSJDK validates this in the first place and it makes the header parsing code quite a bit more complicated too. I'd like to submit a PR to remove the checking but would appreciate knowing in advance if folks are receptive to it.

cc @nh13

@cmnbroad
Copy link
Collaborator

I'd love to see that code removed - its a pretty awkward way to do the order validation anyway. I'd prefer to see it done as part of #1581 though (I'm happy to make the changes there), since that already changes the same public APIs that will have to change for this.

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

No branches or pull requests

2 participants