Feature release: adds Zip output, (partial) support for Windows and improved Python API.
New features
- Add zip VCZ output support to CLI and Python APIs (#462).
- Add
zipzarrCLI to make converting between .vcz and .vcz.zip straightforward (#470) - Add in-memory VCZ output to Python API;
convert()functions (vcf,plink,tskit) andvcf.encode()now return azarr.Group(#462). - Add
plink2zarrPython API documentation (#462). - Preliminary Windows support for tskit and plink conversion (#460)
- Add ancestral allele output (
variant_AA) to tskit output (#469) vcf2zarr inspectnow accepts a.vcz.ziparchive in addition
to a directory store (#471).
Breaking changes
- The
storedsizes reported byvcf2zarr inspectno longer include filesystem inode overhead; they now report the compressed bytes as returned by Zarr'sArray.nbytes_stored()(#471). - Change the metadata format for distributed encode to drop the unused
dimension_separatorfield. The metadata format version has been bumped from0.1to0.2: any in-progress distributeddencoderun started with an earlier version will now fail with a format-version-mismatch error atdencode-partition/dencode-finalisetime and must be restarted fromdencode-init. (#472)
Bug fixes
vcf2zarr convertnow accepts VCFs with zero variant records (plain, tabix-indexed, or CSI-indexed), producing a valid empty VCZ instead of crashing with an unrelated error (#478).- Fix stdlib
typingmodule shadowing caused bybio2zarr/typing.py, which broke thebio2zarrconsole script entry point (#461). - Missing GT incorrectly marked as phased (#454)