Clarified comment for purpose of GatherVcfs #1758
Merged
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.
Description
This very very short PR clarifies the purpose of the
GatherVcfs
tool, changing the phrase "totally discrete" to the more accurate "nonoverlapping." Compare with the Picard documentation here to see this is the intended purpose. The reason this confused me a bit was that technically you could have two vcfs with discrete sets of intervals which do overlap (e.g. chr1:100-101 + chr2:100-101 and chr1:100-101 + chr3:100-101), which certainly should not be used as input into this tool. Changing it here should eventually change the corresponding text on the GATK documentation page as well, once it's incorporated into GATK.Checklist (never delete this)
Never delete this, it is our record that procedure was followed. If you find that for whatever reason one of the checklist points doesn't apply to your PR, you can leave it unchecked but please add an explanation below.
Content
Review
For more detailed guidelines, see https://github.com/broadinstitute/picard/wiki/Guidelines-for-pull-requests