Skip to content

Export mapped variants and add README for public data dump#711

Open
bencap wants to merge 2 commits intorelease-2026.1.3from
feature/bencap/664/include-mapped-variants-in-dump
Open

Export mapped variants and add README for public data dump#711
bencap wants to merge 2 commits intorelease-2026.1.3from
feature/bencap/664/include-mapped-variants-in-dump

Conversation

@bencap
Copy link
Copy Markdown
Collaborator

@bencap bencap commented Apr 15, 2026

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.md describing 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:

  • Added a comprehensive README.md in src/mavedb/scripts/resources that 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.
  • The export script now writes both LICENSE.txt and the new README.md into the ZIP archive, ensuring every dump is self-describing.

Exported Data Enhancements:

  • Added export of mapped variant JSON files (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.
  • Improved the naming and logging of the exported ZIP file to include a timestamp and the number of score sets included.

Script and Code Quality Improvements:

  • Improved log messages to provide clearer progress updates and a final completion message. [1] [2] [3]

Reference to Documentation:

  • The script documentation now refers users to the new README.md for details on archive contents and file formats, instead of duplicating this information in the script itself.

@bencap bencap requested review from jstone-dev and sallybg April 15, 2026 00:22
@bencap bencap linked an issue Apr 15, 2026 that may be closed by this pull request
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

Successfully merging this pull request may close these issues.

Include mapped variant data and README in public data dump

1 participant