Export mapped variants and add README for public data dump#711
Open
bencap wants to merge 2 commits intorelease-2026.1.3from
Open
Export mapped variants and add README for public data dump#711bencap wants to merge 2 commits intorelease-2026.1.3from
bencap wants to merge 2 commits intorelease-2026.1.3from
Conversation
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
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.
This pull request updates the MaveDB public data export script and documentation to improve clarity, add new output files, and better describe the exported data. The most significant changes are the addition of a detailed
README.mddescribing the archive structure and file formats, the inclusion of mapped variant JSON files, and improved logging and documentation in the export script.Documentation and Archive Structure:
README.mdinsrc/mavedb/scripts/resourcesthat explains the archive contents, file formats, and how to use the exported data. This file replaces and significantly expands on the previous in-script documentation.LICENSE.txtand the newREADME.mdinto the ZIP archive, ensuring every dump is self-describing.Exported Data Enhancements:
mapped/{urn}.mapped-variants.json) for score sets that have completed mapping, mirroring the API output. This provides detailed VRS and mapping information for each variant.Script and Code Quality Improvements:
Reference to Documentation:
README.mdfor details on archive contents and file formats, instead of duplicating this information in the script itself.