File tree Expand file tree Collapse file tree 4 files changed +28
-0
lines changed Expand file tree Collapse file tree 4 files changed +28
-0
lines changed Original file line number Diff line number Diff line change 23
23
PLINK
24
24
-----
25
25
26
+ .. deprecated :: 0.11.0
27
+ Functions for reading and writing plink are deprecated, please use the `bio2zarr <https://github.com/sgkit-dev/bio2zarr >`_
28
+ and `vcztools <https://github.com/sgkit-dev/vcztools >`_ packages.
29
+
26
30
.. currentmodule :: sgkit.io.plink
27
31
.. autosummary ::
28
32
:toctree: generated/
Original file line number Diff line number Diff line change
1
+ import warnings
2
+
3
+ warnings .warn (
4
+ "Functions for reading and writing plink are deprecated, please use the bio2zarr and vcztools packages." ,
5
+ DeprecationWarning ,
6
+ stacklevel = 2 ,
7
+ )
8
+
1
9
try :
2
10
from .plink_reader import plink_to_zarr , read_plink
3
11
from .plink_writer import write_plink , zarr_to_plink
Original file line number Diff line number Diff line change @@ -147,6 +147,10 @@ def read_plink(
147
147
Loads a single PLINK dataset as dask arrays within a Dataset
148
148
from bed, bim, and fam files.
149
149
150
+ .. deprecated:: 0.11.0
151
+ Functions for reading and writing plink are deprecated, please use the `bio2zarr <https://github.com/sgkit-dev/bio2zarr>`_
152
+ and `vcztools <https://github.com/sgkit-dev/vcztools>`_ packages.
153
+
150
154
Parameters
151
155
----------
152
156
path
@@ -328,6 +332,10 @@ def plink_to_zarr(
328
332
329
333
Refer to :func:`read_plink` for details and limitations.
330
334
335
+ .. deprecated:: 0.11.0
336
+ Functions for reading and writing plink are deprecated, please use the `bio2zarr <https://github.com/sgkit-dev/bio2zarr>`_
337
+ and `vcztools <https://github.com/sgkit-dev/vcztools>`_ packages.
338
+
331
339
Parameters
332
340
----------
333
341
path
Original file line number Diff line number Diff line change @@ -49,6 +49,10 @@ def write_plink(
49
49
- ``sample_phenotype``: Phenotype code equal to 1 for control, 2 for case,
50
50
and -1 for missing
51
51
52
+ .. deprecated:: 0.11.0
53
+ Functions for reading and writing plink are deprecated, please use the `bio2zarr <https://github.com/sgkit-dev/bio2zarr>`_
54
+ and `vcztools <https://github.com/sgkit-dev/vcztools>`_ packages.
55
+
52
56
Parameters
53
57
----------
54
58
ds
@@ -146,6 +150,10 @@ def zarr_to_plink(
146
150
147
151
Refer to :func:`write_plink` for details and limitations.
148
152
153
+ .. deprecated:: 0.11.0
154
+ Functions for reading and writing plink are deprecated, please use the `bio2zarr <https://github.com/sgkit-dev/bio2zarr>`_
155
+ and `vcztools <https://github.com/sgkit-dev/vcztools>`_ packages.
156
+
149
157
Parameters
150
158
----------
151
159
input
You can’t perform that action at this time.
0 commit comments