@@ -14,8 +14,12 @@ New Features
14
14
- Add 'matching' method to :func: `identity_by_state ` function.
15
15
(:user: `timothymillar `, :pr: `1229 `, :issue: `1227 `)
16
16
17
- .. Breaking changes
18
- .. ~~~~~~~~~~~~~~~~
17
+ Breaking changes
18
+ ~~~~~~~~~~~~~~~~
19
+
20
+ - Functions for reading and writing VCF were removed from sgkit, please use the `bio2zarr <https://github.com/sgkit-dev/bio2zarr >`_
21
+ and `vcztools <https://github.com/sgkit-dev/vcztools >`_ packages instead.
22
+ (:user: `tomwhite `, :pr: `1264 `)
19
23
20
24
.. Deprecations
21
25
.. ~~~~~~~~~~~~
@@ -147,22 +151,22 @@ New Features
147
151
- Add :func: `sgkit.convert_call_to_index ` method.
148
152
(:user: `timothymillar `, :pr: `1050 `, :issue: `1048 `)
149
153
150
- - Add ``read_chunk_length `` option to :func: ` sgkit.io.vcf.vcf_to_zarr ` and
151
- :func: ` sgkit.io.vcf.vcf_to_zarrs ` functions. These are useful to reduce memory usage
154
+ - Add ``read_chunk_length `` option to `` sgkit.io.vcf.vcf_to_zarr ` ` and
155
+ `` sgkit.io.vcf.vcf_to_zarrs ` ` functions. These are useful to reduce memory usage
152
156
with large sample counts or a large ``chunk_length ``.
153
157
(:user: `benjeffery `, :pr: `1044 `, :issue: `1042 `)
154
158
155
- - Add ``retain_temp_files `` to :func: ` sgkit.io.vcf.vcf_to_zarr ` function.
159
+ - Add ``retain_temp_files `` to `` sgkit.io.vcf.vcf_to_zarr ` ` function.
156
160
(:user: `benjeffery `, :pr: `1046 `, :issue: `1036 `)
157
161
158
- - Add :func: ` sgkit.io.vcf.read_vcf ` convenience function.
162
+ - Add `` sgkit.io.vcf.read_vcf ` ` convenience function.
159
163
(:user: `tomwhite `, :pr: `1052 `, :issue: `1004 `)
160
164
161
165
- Add :func: `sgkit.hybrid_relationship `, :func: `sgkit.hybrid_inverse_relationship `
162
166
and :func: `invert_relationship_matrix ` methods.
163
167
(:user: `timothymillar `, :pr: `1053 `, :issue: `993 `)
164
168
165
- - Add :func: ` sgkit.io.vcf.zarr_array_sizes ` for determining array sizes for storage in Zarr.
169
+ - Add `` sgkit.io.vcf.zarr_array_sizes ` ` for determining array sizes for storage in Zarr.
166
170
(:user: `tomwhite `, :pr: `1073 `, :issue: `734 `)
167
171
168
172
- Add ``skipna `` option to :func: `genomic_relationship ` function.
@@ -174,7 +178,7 @@ New Features
174
178
Breaking changes
175
179
~~~~~~~~~~~~~~~~
176
180
177
- - Generate VCF header by default when writing VCF using :func: ` sgkit.io.vcf.write_vcf ` or :func: ` sgkit.io.vcf.zarr_to_vcf `.
181
+ - Generate VCF header by default when writing VCF using `` sgkit.io.vcf.write_vcf `` or `` sgkit.io.vcf.zarr_to_vcf ` `.
178
182
Previously, the dataset had to contain a ``vcf_header `` attribute.
179
183
(:user: `tomwhite `, :pr: `1021 `, :issue: `1020 `)
180
184
0 commit comments