Add descriptions for the fixed fields #262
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 pull request adds descriptions for the fixed fields in VCF Zarr. The fixed VCF Zarr fields are listed here, and descriptions for their corresponding VCF fields are found in the VCF specification. I consulted the specification for VCFv4.3 to come up with the short descriptions.
This pull request closes #124.
Approach
I add a dictionary relating the names of the fixed fields to their descriptions.
ZarrArraySpec
uses the dictionary during post-initialization to set the description field. The description is then set as an attribute of the Zarr array by theVcfZarrWriter
ininit_array
, which is called byinit
.Testing
So far, I have only updated a unit test in
test_vcz.py
that fails with the new changes.