Skip to content

Commit 806c836

Browse files
Update top-level docs pre release
1 parent 2117da1 commit 806c836

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

docs/intro.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
- {ref}`sec-plink2zarr` converts PLINK 1.0 data to
1212
[VCF Zarr](https://github.com/sgkit-dev/vcf-zarr-spec/) format.
1313

14+
- {ref}`sec-tskit2zarr` converts [tskit](https://tskit.dev)
15+
data into [VCF Zarr](https://github.com/sgkit-dev/vcf-zarr-spec/) format.
16+
1417
- {ref}`sec-vcfpartition` is a utility to split an input
1518
VCF into a given number of partitions. This is useful for
1619
parallel processing of VCF data.
@@ -25,13 +28,11 @@ support for other formats such as BGEN (or an interested in helping with impleme
2528
please open an [issue on Github](https://github.com/sgkit-dev/bio2zarr/issues)
2629
to discuss!
2730

31+
## Python APIs
2832

29-
The package is currently focused on command line interfaces, but a
30-
Python API is also planned.
33+
There is access to some limited functionality via Python APIs (documented
34+
along with the respective tools). These are in beta, and should be fully
35+
documented and stabilised in the coming releases. General APIs to enable
36+
efficient and straightforward encoding of data to VCZ are planned
37+
(see [issue #412](https://github.com/sgkit-dev/bio2zarr/issues/412)).
3138

32-
:::{warning}
33-
Although it is possible to import the bio2zarr Python package
34-
the APIs are purely internal for the moment and will change
35-
in arbitrary ways. Please don't use them (or open issues about
36-
them on GitHub).
37-
:::

0 commit comments

Comments
 (0)