Skip to content

Commit 8202bdc

Browse files
Finish up docs for plink and update CHANGELOG
1 parent 8a2192c commit 8202bdc

File tree

3 files changed

+11
-7
lines changed

3 files changed

+11
-7
lines changed

CHANGELOG.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# 0.1.6 2025-0X-XX
22

3-
- Make format-specific dependencies optional (#385)
4-
5-
- Add contigs to plink output (#344)
3+
- Initial version of supported plink2zarr (#390, #344, #382)
64

7-
- Add variant_length and indexing to plink output (#382)
5+
- Make format-specific dependencies optional (#385)
86

97
Breaking changes
108

@@ -14,6 +12,8 @@ Breaking changes
1412
- Add dimensions and default compressor and filter settings to the schema.
1513
(#361)
1614

15+
- Various changes to existing experimental plink encoding (#390)
16+
1717
# 0.1.5 2025-03-31
1818

1919
- Add support for merging contig IDs across multiple VCFs (#335)

docs/_toc.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ chapters:
66
sections:
77
- file: vcf2zarr/tutorial
88
- file: vcf2zarr/cli_ref
9+
- file: plink2zarr/overview
10+
sections:
11+
- file: plink2zarr/cli_ref
912
- file: vcfpartition/overview
1013
sections:
1114
- file: vcfpartition/cli_ref

docs/intro.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88
- {ref}`sec-vcf2zarr` converts VCF data to
99
[VCF Zarr](https://github.com/sgkit-dev/vcf-zarr-spec/) format.
1010

11+
- {ref}`sec-plink2zarr` converts PLINK 1.0 data to
12+
[VCF Zarr](https://github.com/sgkit-dev/vcf-zarr-spec/) format.
13+
1114
- {ref}`sec-vcfpartition` is a utility to split an input
1215
VCF into a given number of partitions. This is useful for
1316
parallel processing of VCF data.
@@ -17,10 +20,8 @@
1720
`bio2zarr` is in development, contributions, feedback and issues are welcome
1821
at the [GitHub repository](https://github.com/sgkit-dev/bio2zarr).
1922

20-
Support for converting PLINK data to VCF Zarr is partially implemented,
21-
and adding BGEN and [tskit](https://tskit.dev/) support is also planned.
2223
If you would like to see
23-
support for other formats (or an interested in helping with implementing),
24+
support for other formats such as BGEN (or an interested in helping with implementing),
2425
please open an [issue on Github](https://github.com/sgkit-dev/bio2zarr/issues)
2526
to discuss!
2627

0 commit comments

Comments
 (0)