Clarify GBWT usage in vg map --gbwt-name - #5005
Merged
Merged
Conversation
adamnovak
approved these changes
Aug 12, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changelog Entry
To be copied to the draft changelog by merger:
vg map --gbwt-nameoption (resolves Better option description for using GBWT #1429)Description
The
--gbwt-nameoption (and other things that trigger GBWT usage) all end up with feeding into ahaplo_score_providerwhich is optionally used inapply_haplotype_consistency_scores()to, well, apply haplotype consistency scores. While GBWT index is not generally required, if it isn't passed then that score check never occurs. This PR makes that clear in the helptext.