Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove VCF support #1264

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

Remove VCF support #1264

wants to merge 8 commits into from

Conversation

tomwhite
Copy link
Collaborator

@tomwhite tomwhite commented Sep 24, 2024

  • User visible changes (including notable bug fixes) are documented in changelog.rst

This removes the VCF reading and writing functionality from sgkit, since better implementations are available (and being actively developed) in the bio2zarr and vcztools projects.

I had hoped to remove only the VCF reading functions in this PR, but the writing side is quite entwined (e.g. due to testing), so it would be much easier to remove them both at once. We haven't deprecated the VCF write functions yet (#1245), since that is waiting on releasing vcztools.

So I've marked this as a draft as it's not ready to be merged yet. It would be good to get people's feedback though as this is quite a big change.

@tomwhite tomwhite added documentation Improvements or additions to documentation IO Issues related to reading and writing common third-party file formats labels Sep 24, 2024
Copy link
Collaborator

@jeromekelleher jeromekelleher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 !!

It mainly looks like such a big diff because of all the tests, and data, but that's all ported to bio2zarr, pretty much.

@tomwhite
Copy link
Collaborator Author

tomwhite commented Oct 2, 2024

We discussed this in the developers meeting and the consensus there was it would be good to merge this as it removes a lot of unsupported code.

All tests are now passing except for the ones that use NumPy 2, which will need a bio2zarr release (see sgkit-dev/bio2zarr#256).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation IO Issues related to reading and writing common third-party file formats
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants