bio2zarr 0.0.5__py3-none-any.whl → 0.0.9__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- bio2zarr/_version.py +2 -2
- bio2zarr/cli.py +126 -25
- bio2zarr/core.py +31 -3
- bio2zarr/vcf.py +754 -475
- bio2zarr/vcf_utils.py +25 -16
- bio2zarr-0.0.9.dist-info/METADATA +363 -0
- bio2zarr-0.0.9.dist-info/RECORD +16 -0
- bio2zarr-0.0.5.dist-info/METADATA +0 -33
- bio2zarr-0.0.5.dist-info/RECORD +0 -16
- {bio2zarr-0.0.5.dist-info → bio2zarr-0.0.9.dist-info}/LICENSE +0 -0
- {bio2zarr-0.0.5.dist-info → bio2zarr-0.0.9.dist-info}/WHEEL +0 -0
- {bio2zarr-0.0.5.dist-info → bio2zarr-0.0.9.dist-info}/entry_points.txt +0 -0
- {bio2zarr-0.0.5.dist-info → bio2zarr-0.0.9.dist-info}/top_level.txt +0 -0
bio2zarr/vcf_utils.py
CHANGED
|
@@ -3,8 +3,9 @@ import gzip
|
|
|
3
3
|
import os
|
|
4
4
|
import pathlib
|
|
5
5
|
import struct
|
|
6
|
+
from collections.abc import Sequence
|
|
6
7
|
from dataclasses import dataclass
|
|
7
|
-
from typing import IO, Any,
|
|
8
|
+
from typing import IO, Any, Optional, Union
|
|
8
9
|
|
|
9
10
|
import cyvcf2
|
|
10
11
|
import humanfriendly
|
|
@@ -75,6 +76,10 @@ def read_bytes_as_tuple(f: IO[Any], fmt: str) -> Sequence[Any]:
|
|
|
75
76
|
|
|
76
77
|
@dataclass
|
|
77
78
|
class Region:
|
|
79
|
+
"""
|
|
80
|
+
A htslib style region, where coordinates are 1-based and inclusive.
|
|
81
|
+
"""
|
|
82
|
+
|
|
78
83
|
contig: str
|
|
79
84
|
start: Optional[int] = None
|
|
80
85
|
end: Optional[int] = None
|
|
@@ -85,7 +90,7 @@ class Region:
|
|
|
85
90
|
assert self.start > 0
|
|
86
91
|
if self.end is not None:
|
|
87
92
|
self.end = int(self.end)
|
|
88
|
-
assert self.end
|
|
93
|
+
assert self.end >= self.start
|
|
89
94
|
|
|
90
95
|
def __str__(self):
|
|
91
96
|
s = f"{self.contig}"
|
|
@@ -112,6 +117,9 @@ class CSIBin:
|
|
|
112
117
|
chunks: Sequence[Chunk]
|
|
113
118
|
|
|
114
119
|
|
|
120
|
+
RECORD_COUNT_UNKNOWN = np.inf
|
|
121
|
+
|
|
122
|
+
|
|
115
123
|
@dataclass
|
|
116
124
|
class CSIIndex:
|
|
117
125
|
min_shift: int
|
|
@@ -183,7 +191,7 @@ def get_first_locus_in_bin(csi: CSIIndex, bin: int) -> int:
|
|
|
183
191
|
|
|
184
192
|
|
|
185
193
|
def read_csi(
|
|
186
|
-
file: PathType, storage_options: Optional[
|
|
194
|
+
file: PathType, storage_options: Optional[dict[str, str]] = None
|
|
187
195
|
) -> CSIIndex:
|
|
188
196
|
"""Parse a CSI file into a `CSIIndex` object.
|
|
189
197
|
|
|
@@ -220,7 +228,9 @@ def read_csi(
|
|
|
220
228
|
for _ in range(n_ref):
|
|
221
229
|
n_bin = read_bytes_as_value(f, "<i")
|
|
222
230
|
seq_bins = []
|
|
223
|
-
|
|
231
|
+
# Distinguish between counts that are zero because the sequence
|
|
232
|
+
# isn't there, vs counts that aren't in the index.
|
|
233
|
+
record_count = 0 if n_bin == 0 else RECORD_COUNT_UNKNOWN
|
|
224
234
|
for _ in range(n_bin):
|
|
225
235
|
bin, loffset, n_chunk = read_bytes_as_tuple(f, "<IQi")
|
|
226
236
|
chunks = []
|
|
@@ -297,7 +307,7 @@ class TabixIndex:
|
|
|
297
307
|
|
|
298
308
|
|
|
299
309
|
def read_tabix(
|
|
300
|
-
file: PathType, storage_options: Optional[
|
|
310
|
+
file: PathType, storage_options: Optional[dict[str, str]] = None
|
|
301
311
|
) -> TabixIndex:
|
|
302
312
|
"""Parse a tabix file into a `TabixIndex` object.
|
|
303
313
|
|
|
@@ -336,7 +346,9 @@ def read_tabix(
|
|
|
336
346
|
for _ in range(header.n_ref):
|
|
337
347
|
n_bin = read_bytes_as_value(f, "<i")
|
|
338
348
|
seq_bins = []
|
|
339
|
-
|
|
349
|
+
# Distinguish between counts that are zero because the sequence
|
|
350
|
+
# isn't there, vs counts that aren't in the index.
|
|
351
|
+
record_count = 0 if n_bin == 0 else RECORD_COUNT_UNKNOWN
|
|
340
352
|
for _ in range(n_bin):
|
|
341
353
|
bin, n_chunk = read_bytes_as_tuple(f, "<Ii")
|
|
342
354
|
chunks = []
|
|
@@ -435,19 +447,16 @@ class IndexedVcf(contextlib.AbstractContextManager):
|
|
|
435
447
|
if var.POS >= start:
|
|
436
448
|
yield var
|
|
437
449
|
|
|
438
|
-
def
|
|
450
|
+
def _filter_empty_and_refine(self, regions):
|
|
439
451
|
"""
|
|
440
|
-
Return all regions in the specified list that have one or more records
|
|
441
|
-
|
|
442
|
-
Sometimes with Tabix indexes these seem to crop up:
|
|
443
|
-
|
|
444
|
-
- https://github.com/sgkit-dev/bio2zarr/issues/45
|
|
445
|
-
- https://github.com/sgkit-dev/bio2zarr/issues/120
|
|
452
|
+
Return all regions in the specified list that have one or more records,
|
|
453
|
+
and refine the start coordinate of the region to be the actual first coord
|
|
446
454
|
"""
|
|
447
455
|
ret = []
|
|
448
456
|
for region in regions:
|
|
449
|
-
|
|
450
|
-
if
|
|
457
|
+
var = next(self.variants(region), None)
|
|
458
|
+
if var is not None:
|
|
459
|
+
region.start = var.POS
|
|
451
460
|
ret.append(region)
|
|
452
461
|
return ret
|
|
453
462
|
|
|
@@ -527,4 +536,4 @@ class IndexedVcf(contextlib.AbstractContextManager):
|
|
|
527
536
|
if self.index.record_counts[ri] > 0:
|
|
528
537
|
regions.append(Region(self.sequence_names[ri]))
|
|
529
538
|
|
|
530
|
-
return self.
|
|
539
|
+
return self._filter_empty_and_refine(regions)
|
|
@@ -0,0 +1,363 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: bio2zarr
|
|
3
|
+
Version: 0.0.9
|
|
4
|
+
Summary: Convert bioinformatics data to Zarr
|
|
5
|
+
Author-email: sgkit Developers <project@sgkit.dev>
|
|
6
|
+
License: Apache License
|
|
7
|
+
Version 2.0, January 2004
|
|
8
|
+
http://www.apache.org/licenses/
|
|
9
|
+
|
|
10
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
11
|
+
|
|
12
|
+
1. Definitions.
|
|
13
|
+
|
|
14
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
15
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
16
|
+
|
|
17
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
18
|
+
the copyright owner that is granting the License.
|
|
19
|
+
|
|
20
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
21
|
+
other entities that control, are controlled by, or are under common
|
|
22
|
+
control with that entity. For the purposes of this definition,
|
|
23
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
24
|
+
direction or management of such entity, whether by contract or
|
|
25
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
26
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
27
|
+
|
|
28
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
29
|
+
exercising permissions granted by this License.
|
|
30
|
+
|
|
31
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
32
|
+
including but not limited to software source code, documentation
|
|
33
|
+
source, and configuration files.
|
|
34
|
+
|
|
35
|
+
"Object" form shall mean any form resulting from mechanical
|
|
36
|
+
transformation or translation of a Source form, including but
|
|
37
|
+
not limited to compiled object code, generated documentation,
|
|
38
|
+
and conversions to other media types.
|
|
39
|
+
|
|
40
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
41
|
+
Object form, made available under the License, as indicated by a
|
|
42
|
+
copyright notice that is included in or attached to the work
|
|
43
|
+
(an example is provided in the Appendix below).
|
|
44
|
+
|
|
45
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
46
|
+
form, that is based on (or derived from) the Work and for which the
|
|
47
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
48
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
49
|
+
of this License, Derivative Works shall not include works that remain
|
|
50
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
51
|
+
the Work and Derivative Works thereof.
|
|
52
|
+
|
|
53
|
+
"Contribution" shall mean any work of authorship, including
|
|
54
|
+
the original version of the Work and any modifications or additions
|
|
55
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
56
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
57
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
58
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
59
|
+
means any form of electronic, verbal, or written communication sent
|
|
60
|
+
to the Licensor or its representatives, including but not limited to
|
|
61
|
+
communication on electronic mailing lists, source code control systems,
|
|
62
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
63
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
64
|
+
excluding communication that is conspicuously marked or otherwise
|
|
65
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
66
|
+
|
|
67
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
68
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
69
|
+
subsequently incorporated within the Work.
|
|
70
|
+
|
|
71
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
72
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
73
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
74
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
75
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
76
|
+
Work and such Derivative Works in Source or Object form.
|
|
77
|
+
|
|
78
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
79
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
80
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
81
|
+
(except as stated in this section) patent license to make, have made,
|
|
82
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
83
|
+
where such license applies only to those patent claims licensable
|
|
84
|
+
by such Contributor that are necessarily infringed by their
|
|
85
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
86
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
87
|
+
institute patent litigation against any entity (including a
|
|
88
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
89
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
90
|
+
or contributory patent infringement, then any patent licenses
|
|
91
|
+
granted to You under this License for that Work shall terminate
|
|
92
|
+
as of the date such litigation is filed.
|
|
93
|
+
|
|
94
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
95
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
96
|
+
modifications, and in Source or Object form, provided that You
|
|
97
|
+
meet the following conditions:
|
|
98
|
+
|
|
99
|
+
(a) You must give any other recipients of the Work or
|
|
100
|
+
Derivative Works a copy of this License; and
|
|
101
|
+
|
|
102
|
+
(b) You must cause any modified files to carry prominent notices
|
|
103
|
+
stating that You changed the files; and
|
|
104
|
+
|
|
105
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
106
|
+
that You distribute, all copyright, patent, trademark, and
|
|
107
|
+
attribution notices from the Source form of the Work,
|
|
108
|
+
excluding those notices that do not pertain to any part of
|
|
109
|
+
the Derivative Works; and
|
|
110
|
+
|
|
111
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
112
|
+
distribution, then any Derivative Works that You distribute must
|
|
113
|
+
include a readable copy of the attribution notices contained
|
|
114
|
+
within such NOTICE file, excluding those notices that do not
|
|
115
|
+
pertain to any part of the Derivative Works, in at least one
|
|
116
|
+
of the following places: within a NOTICE text file distributed
|
|
117
|
+
as part of the Derivative Works; within the Source form or
|
|
118
|
+
documentation, if provided along with the Derivative Works; or,
|
|
119
|
+
within a display generated by the Derivative Works, if and
|
|
120
|
+
wherever such third-party notices normally appear. The contents
|
|
121
|
+
of the NOTICE file are for informational purposes only and
|
|
122
|
+
do not modify the License. You may add Your own attribution
|
|
123
|
+
notices within Derivative Works that You distribute, alongside
|
|
124
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
125
|
+
that such additional attribution notices cannot be construed
|
|
126
|
+
as modifying the License.
|
|
127
|
+
|
|
128
|
+
You may add Your own copyright statement to Your modifications and
|
|
129
|
+
may provide additional or different license terms and conditions
|
|
130
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
131
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
132
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
133
|
+
the conditions stated in this License.
|
|
134
|
+
|
|
135
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
136
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
137
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
138
|
+
this License, without any additional terms or conditions.
|
|
139
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
140
|
+
the terms of any separate license agreement you may have executed
|
|
141
|
+
with Licensor regarding such Contributions.
|
|
142
|
+
|
|
143
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
144
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
145
|
+
except as required for reasonable and customary use in describing the
|
|
146
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
147
|
+
|
|
148
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
149
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
150
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
151
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
152
|
+
implied, including, without limitation, any warranties or conditions
|
|
153
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
154
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
155
|
+
appropriateness of using or redistributing the Work and assume any
|
|
156
|
+
risks associated with Your exercise of permissions under this License.
|
|
157
|
+
|
|
158
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
159
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
160
|
+
unless required by applicable law (such as deliberate and grossly
|
|
161
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
162
|
+
liable to You for damages, including any direct, indirect, special,
|
|
163
|
+
incidental, or consequential damages of any character arising as a
|
|
164
|
+
result of this License or out of the use or inability to use the
|
|
165
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
166
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
167
|
+
other commercial damages or losses), even if such Contributor
|
|
168
|
+
has been advised of the possibility of such damages.
|
|
169
|
+
|
|
170
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
171
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
172
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
173
|
+
or other liability obligations and/or rights consistent with this
|
|
174
|
+
License. However, in accepting such obligations, You may act only
|
|
175
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
176
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
177
|
+
defend, and hold each Contributor harmless for any liability
|
|
178
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
179
|
+
of your accepting any such warranty or additional liability.
|
|
180
|
+
|
|
181
|
+
END OF TERMS AND CONDITIONS
|
|
182
|
+
|
|
183
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
184
|
+
|
|
185
|
+
To apply the Apache License to your work, attach the following
|
|
186
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
187
|
+
replaced with your own identifying information. (Don't include
|
|
188
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
189
|
+
comment syntax for the file format. We also recommend that a
|
|
190
|
+
file or class name and description of purpose be included on the
|
|
191
|
+
same "printed page" as the copyright notice for easier
|
|
192
|
+
identification within third-party archives.
|
|
193
|
+
|
|
194
|
+
Copyright [yyyy] [name of copyright owner]
|
|
195
|
+
|
|
196
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
197
|
+
you may not use this file except in compliance with the License.
|
|
198
|
+
You may obtain a copy of the License at
|
|
199
|
+
|
|
200
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
201
|
+
|
|
202
|
+
Unless required by applicable law or agreed to in writing, software
|
|
203
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
204
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
205
|
+
See the License for the specific language governing permissions and
|
|
206
|
+
limitations under the License.
|
|
207
|
+
|
|
208
|
+
Project-URL: repository, https://github.com/sgkit-dev/bio2zarr
|
|
209
|
+
Project-URL: documentation, https://sgkit-dev.github.io/bio2zarr/intro.html
|
|
210
|
+
Classifier: Development Status :: 3 - Alpha
|
|
211
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
212
|
+
Classifier: Operating System :: OS Independent
|
|
213
|
+
Classifier: Intended Audience :: Science/Research
|
|
214
|
+
Classifier: Programming Language :: Python
|
|
215
|
+
Classifier: Programming Language :: Python :: 3
|
|
216
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
217
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
218
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
219
|
+
Classifier: Topic :: Scientific/Engineering
|
|
220
|
+
Requires-Python: >=3.9
|
|
221
|
+
Description-Content-Type: text/markdown
|
|
222
|
+
License-File: LICENSE
|
|
223
|
+
Requires-Dist: numpy
|
|
224
|
+
Requires-Dist: zarr >=2.17
|
|
225
|
+
Requires-Dist: click
|
|
226
|
+
Requires-Dist: tabulate
|
|
227
|
+
Requires-Dist: tqdm
|
|
228
|
+
Requires-Dist: humanfriendly
|
|
229
|
+
Requires-Dist: cyvcf2
|
|
230
|
+
Requires-Dist: bed-reader
|
|
231
|
+
Provides-Extra: dev
|
|
232
|
+
Requires-Dist: msprime ; extra == 'dev'
|
|
233
|
+
Requires-Dist: pysam ; extra == 'dev'
|
|
234
|
+
Requires-Dist: pytest ; extra == 'dev'
|
|
235
|
+
Requires-Dist: pytest-coverage ; extra == 'dev'
|
|
236
|
+
Requires-Dist: pytest-xdist ; extra == 'dev'
|
|
237
|
+
Requires-Dist: sgkit >=0.8.0 ; extra == 'dev'
|
|
238
|
+
Requires-Dist: tqdm ; extra == 'dev'
|
|
239
|
+
|
|
240
|
+
[](https://github.com/sgkit-dev/bio2zarr/actions/workflows/ci.yml)
|
|
241
|
+
|
|
242
|
+
# bio2zarr
|
|
243
|
+
Convert bioinformatics file formats to Zarr
|
|
244
|
+
|
|
245
|
+
Initially supports converting VCF to the
|
|
246
|
+
[sgkit vcf-zarr specification](https://github.com/pystatgen/vcf-zarr-spec/)
|
|
247
|
+
|
|
248
|
+
**This is early alpha-status code: everything is subject to change,
|
|
249
|
+
and it has not been thoroughly tested**
|
|
250
|
+
|
|
251
|
+
## Install
|
|
252
|
+
|
|
253
|
+
```
|
|
254
|
+
$ python3 -m pip install bio2zarr
|
|
255
|
+
```
|
|
256
|
+
|
|
257
|
+
This will install the programs ``vcf2zarr``, ``plink2zarr`` and ``vcf_partition``
|
|
258
|
+
into your local Python path. You may need to update your $PATH to call the
|
|
259
|
+
executables directly.
|
|
260
|
+
|
|
261
|
+
Alternatively, calling
|
|
262
|
+
```
|
|
263
|
+
$ python3 -m bio2zarr vcf2zarr <args>
|
|
264
|
+
```
|
|
265
|
+
is equivalent to
|
|
266
|
+
|
|
267
|
+
```
|
|
268
|
+
$ vcf2zarr <args>
|
|
269
|
+
```
|
|
270
|
+
and will always work.
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
## vcf2zarr
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
Convert a VCF to zarr format:
|
|
277
|
+
|
|
278
|
+
```
|
|
279
|
+
$ vcf2zarr convert <VCF1> <VCF2> <zarr>
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
Converts the VCF to zarr format.
|
|
283
|
+
|
|
284
|
+
**Do not use this for anything but the smallest files**
|
|
285
|
+
|
|
286
|
+
The recommended approach is to use a multi-stage conversion
|
|
287
|
+
|
|
288
|
+
First, convert the VCF into the intermediate format:
|
|
289
|
+
|
|
290
|
+
```
|
|
291
|
+
vcf2zarr explode tests/data/vcf/sample.vcf.gz tmp/sample.exploded
|
|
292
|
+
```
|
|
293
|
+
|
|
294
|
+
Then, (optionally) inspect this representation to get a feel for your dataset
|
|
295
|
+
```
|
|
296
|
+
vcf2zarr inspect tmp/sample.exploded
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
Then, (optionally) generate a conversion schema to describe the corresponding
|
|
300
|
+
Zarr arrays:
|
|
301
|
+
|
|
302
|
+
```
|
|
303
|
+
vcf2zarr mkschema tmp/sample.exploded > sample.schema.json
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
View and edit the schema, deleting any columns you don't want, or tweaking
|
|
307
|
+
dtypes and compression settings to your taste.
|
|
308
|
+
|
|
309
|
+
Finally, encode to Zarr:
|
|
310
|
+
```
|
|
311
|
+
vcf2zarr encode tmp/sample.exploded tmp/sample.zarr -s sample.schema.json
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
Use the ``-p, --worker-processes`` argument to control the number of workers used
|
|
315
|
+
in the ``explode`` and ``encode`` phases.
|
|
316
|
+
|
|
317
|
+
### Shell completion
|
|
318
|
+
|
|
319
|
+
To enable shell completion for a particular session in Bash do:
|
|
320
|
+
|
|
321
|
+
```
|
|
322
|
+
eval "$(_VCF2ZARR_COMPLETE=bash_source vcf2zarr)"
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
If you add this to your ``.bashrc`` vcf2zarr shell completion should available
|
|
326
|
+
in all new shell sessions.
|
|
327
|
+
|
|
328
|
+
See the [Click documentation](https://click.palletsprojects.com/en/8.1.x/shell-completion/#enabling-completion)
|
|
329
|
+
for instructions on how to enable completion in other shells.
|
|
330
|
+
a
|
|
331
|
+
|
|
332
|
+
## plink2zarr
|
|
333
|
+
|
|
334
|
+
Convert a plink ``.bed`` file to zarr format. **This is incomplete**
|
|
335
|
+
|
|
336
|
+
## vcf_partition
|
|
337
|
+
|
|
338
|
+
Partition a given VCF file into (approximately) a give number of regions:
|
|
339
|
+
|
|
340
|
+
```
|
|
341
|
+
vcf_partition 20201028_CCDG_14151_B01_GRM_WGS_2020-08-05_chr20.recalibrated_variants.vcf.gz -n 10
|
|
342
|
+
```
|
|
343
|
+
gives
|
|
344
|
+
```
|
|
345
|
+
chr20:1-6799360
|
|
346
|
+
chr20:6799361-14319616
|
|
347
|
+
chr20:14319617-21790720
|
|
348
|
+
chr20:21790721-28770304
|
|
349
|
+
chr20:28770305-31096832
|
|
350
|
+
chr20:31096833-38043648
|
|
351
|
+
chr20:38043649-45580288
|
|
352
|
+
chr20:45580289-52117504
|
|
353
|
+
chr20:52117505-58834944
|
|
354
|
+
chr20:58834945-
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
These reqion strings can then be used to split computation of the VCF
|
|
358
|
+
into chunks for parallelisation.
|
|
359
|
+
|
|
360
|
+
**TODO give a nice example here using xargs**
|
|
361
|
+
|
|
362
|
+
**WARNING that this does not take into account that indels may overlap
|
|
363
|
+
partitions and you may count variants twice or more if they do**
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
bio2zarr/__init__.py,sha256=KiUGyya-9RHNcBldB8Lc1g3rP3CRjaL-5Olben0_6qA,49
|
|
2
|
+
bio2zarr/__main__.py,sha256=hO4vV-kPFgsYq0NQwG2r-WkserPL27oqae_tUvNB7yE,527
|
|
3
|
+
bio2zarr/_version.py,sha256=VUKDhsDLOPKj9zNw_322lJTB3k9JKH6BOu4nkEc42KY,411
|
|
4
|
+
bio2zarr/cli.py,sha256=d3UOyD6CSsMvHWDKMEuM9LyuQTjlxQrBMTHbRFbHE6w,14376
|
|
5
|
+
bio2zarr/core.py,sha256=Zqb69LoUIxlUSUVY5K2V3dmKLsW0RxHkPKnWbvmVb5I,9006
|
|
6
|
+
bio2zarr/plink.py,sha256=huXMlxQ5C3gPmOYCavA-QW7PzaV48I2lo80cQqHT1wY,6768
|
|
7
|
+
bio2zarr/provenance.py,sha256=c_Z__QbWkLS0Rfa8D7LgEhtStng_zRMJX8comaDXIkw,142
|
|
8
|
+
bio2zarr/typing.py,sha256=BYxhL16sKRoNxa6amf6AYxvt5Ke9qzv2np_kOT_zPJo,79
|
|
9
|
+
bio2zarr/vcf.py,sha256=Denl125T2UBc6fIoFWCENXct847jbtMzH6fU1qbEMK8,84757
|
|
10
|
+
bio2zarr/vcf_utils.py,sha256=4tTgXSAD6OO7jraHcNsi4l1aa1UA2n9FDnQQlzZusts,17777
|
|
11
|
+
bio2zarr-0.0.9.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
|
|
12
|
+
bio2zarr-0.0.9.dist-info/METADATA,sha256=-dKozh-rd_KaI7MJOnT-WcOOmxDEpuiSsZobuvkNU38,17384
|
|
13
|
+
bio2zarr-0.0.9.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
|
|
14
|
+
bio2zarr-0.0.9.dist-info/entry_points.txt,sha256=pklStOdATE5hHJm4qiIvmhHkcn21Si_XAu6MC7ieNrk,131
|
|
15
|
+
bio2zarr-0.0.9.dist-info/top_level.txt,sha256=ouAvp3u9N25eKrQbN8BCDLPcWWQLhtlgdHKu8AtEj5Q,9
|
|
16
|
+
bio2zarr-0.0.9.dist-info/RECORD,,
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
Metadata-Version: 2.1
|
|
2
|
-
Name: bio2zarr
|
|
3
|
-
Version: 0.0.5
|
|
4
|
-
Summary: Convert bioinformatics data to Zarr
|
|
5
|
-
Home-page: https://github.com/pystatgen/bio2zarr
|
|
6
|
-
Author: sgkit Developers
|
|
7
|
-
Author-email: project@pystatgen.org
|
|
8
|
-
License: Apache
|
|
9
|
-
Classifier: Development Status :: 3 - Alpha
|
|
10
|
-
Classifier: License :: OSI Approved :: Apache Software License
|
|
11
|
-
Classifier: Operating System :: OS Independent
|
|
12
|
-
Classifier: Intended Audience :: Science/Research
|
|
13
|
-
Classifier: Programming Language :: Python
|
|
14
|
-
Classifier: Programming Language :: Python :: 3
|
|
15
|
-
Classifier: Programming Language :: Python :: 3.9
|
|
16
|
-
Classifier: Programming Language :: Python :: 3.10
|
|
17
|
-
Classifier: Programming Language :: Python :: 3.11
|
|
18
|
-
Classifier: Topic :: Scientific/Engineering
|
|
19
|
-
Requires-Python: >=3.9
|
|
20
|
-
Description-Content-Type: text/x-rst
|
|
21
|
-
License-File: LICENSE
|
|
22
|
-
Requires-Dist: numpy
|
|
23
|
-
Requires-Dist: zarr >=2.17
|
|
24
|
-
Requires-Dist: click
|
|
25
|
-
Requires-Dist: tabulate
|
|
26
|
-
Requires-Dist: tqdm
|
|
27
|
-
Requires-Dist: humanfriendly
|
|
28
|
-
Requires-Dist: cyvcf2
|
|
29
|
-
Requires-Dist: bed-reader
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
This is an early alpha release for testing and development.
|
|
33
|
-
**Do not use in production**
|
bio2zarr-0.0.5.dist-info/RECORD
DELETED
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
bio2zarr/__init__.py,sha256=KiUGyya-9RHNcBldB8Lc1g3rP3CRjaL-5Olben0_6qA,49
|
|
2
|
-
bio2zarr/__main__.py,sha256=hO4vV-kPFgsYq0NQwG2r-WkserPL27oqae_tUvNB7yE,527
|
|
3
|
-
bio2zarr/_version.py,sha256=EJB7__SNK9kQS_SWZB_U4DHJ3P8ftF6etZEihTYnuXE,411
|
|
4
|
-
bio2zarr/cli.py,sha256=k63xex-tQkogAlJ3N68Ikx8LqZrksXbZB2s6Z7h-zXc,11446
|
|
5
|
-
bio2zarr/core.py,sha256=reF9elN1dwmCoXXLgci-y5pXmAm3fTntmomHTRcG54g,8127
|
|
6
|
-
bio2zarr/plink.py,sha256=huXMlxQ5C3gPmOYCavA-QW7PzaV48I2lo80cQqHT1wY,6768
|
|
7
|
-
bio2zarr/provenance.py,sha256=c_Z__QbWkLS0Rfa8D7LgEhtStng_zRMJX8comaDXIkw,142
|
|
8
|
-
bio2zarr/typing.py,sha256=BYxhL16sKRoNxa6amf6AYxvt5Ke9qzv2np_kOT_zPJo,79
|
|
9
|
-
bio2zarr/vcf.py,sha256=GFnwR2YP-cHU4tfHloRjyiBK9-xXDgXcAM_tz-w2qck,74324
|
|
10
|
-
bio2zarr/vcf_utils.py,sha256=r3NQXxWK1SYU7CcwDzSWXdX5Q8Ixk7gdCTEiFPzfUAk,17307
|
|
11
|
-
bio2zarr-0.0.5.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
|
|
12
|
-
bio2zarr-0.0.5.dist-info/METADATA,sha256=SasGYcKSRb7NqnYR98ODFvPEMdBNdpxWx5gqOt038QU,1077
|
|
13
|
-
bio2zarr-0.0.5.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
|
|
14
|
-
bio2zarr-0.0.5.dist-info/entry_points.txt,sha256=pklStOdATE5hHJm4qiIvmhHkcn21Si_XAu6MC7ieNrk,131
|
|
15
|
-
bio2zarr-0.0.5.dist-info/top_level.txt,sha256=ouAvp3u9N25eKrQbN8BCDLPcWWQLhtlgdHKu8AtEj5Q,9
|
|
16
|
-
bio2zarr-0.0.5.dist-info/RECORD,,
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|