Skip to content

Commit 77a7579

Browse files
Update top-level docs to give a basic idea of status
1 parent b324859 commit 77a7579

File tree

3 files changed

+23
-3
lines changed

3 files changed

+23
-3
lines changed

docs/intro.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,25 @@
11
# bio2zarr
22

33
`bio2zarr` efficiently converts common bioinformatics formats to
4-
[Zarr](https://zarr.readthedocs.io/en/stable/) format. Initially supporting converting
5-
VCF to the [VCF Zarr specification](https://github.com/sgkit-dev/vcf-zarr-spec/).
4+
[Zarr](https://zarr.readthedocs.io/en/stable/) format.
5+
6+
## Tools
7+
8+
- {ref}`sec-vcf2zarr` converts VCF data to
9+
[VCF Zarr](https://github.com/sgkit-dev/vcf-zarr-spec/) format.
10+
11+
- {ref}`sec-vcfpartition` is a utility to split an input (set of)
12+
VCFs into a given number of partitions. This is useful for
13+
parallel processing.
14+
15+
## Development status
616

717
`bio2zarr` is in development, contributions, feedback and issues are welcome
818
at the [GitHub repository](https://github.com/sgkit-dev/bio2zarr).
919

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

docs/vcf2zarr/overview.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
1+
(sec-vcf2zarr)=
12
# vcf2zarr
23

34

4-
Convert a VCF to zarr format:
5+
Convert VCF data to the
6+
[VCF Zarr specification](https://github.com/sgkit-dev/vcf-zarr-spec/)
7+
reliably, in parallel.
58

69
```
710
$ vcf2zarr convert <VCF1> <VCF2> <zarr>

docs/vcfpartition/overview.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
(sec-vcfpartition)=
12
# vcfpartition
23

34
## Overview

0 commit comments

Comments
 (0)