File tree Expand file tree Collapse file tree 3 files changed +39
-8
lines changed
Expand file tree Collapse file tree 3 files changed +39
-8
lines changed Original file line number Diff line number Diff line change 1- .. currentmodule :: sgkit
2-
31#############
42API reference
53#############
64
75This page provides an auto-generated summary of sgkits's API.
86
7+ IO/imports
8+ ==========
9+
10+ .. currentmodule :: sgkit.io.plink
11+ .. autosummary ::
12+ :toctree: generated/
13+
14+ read_plink
15+
16+ .. currentmodule :: sgkit
17+ .. autosummary ::
18+ :toctree: generated/
19+
20+ read_vcfzarr
21+
22+ .. currentmodule :: sgkit
23+
924Creating a dataset
1025==================
1126
@@ -14,7 +29,6 @@ Creating a dataset
1429
1530 create_genotype_call_dataset
1631 create_genotype_dosage_dataset
17- read_vcfzarr
1832
1933Methods
2034=======
Original file line number Diff line number Diff line change @@ -2,12 +2,13 @@ sgkit: Statistical genetics toolkit in Python
22=============================================
33
44.. toctree ::
5- :maxdepth: 2
6- :caption: Contents:
5+ :maxdepth: 2
6+ :caption: Contents:
77
8- api
9- usage
10- contributing
8+ api
9+ usage
10+ io
11+ contributing
1112
1213
1314Indices and tables
Original file line number Diff line number Diff line change 1+ .. _io :
2+
3+ IOs
4+ ===
5+
6+ PLINK
7+ -----
8+
9+ The :func: `sgkit.io.plink.read_plink ` loads a single PLINK dataset as Dask
10+ arrays within an `xr.Dataset ` from bed, bim, and fam files.
11+
12+ PLINK IO support is an "extra" feature within sgkit and requires additional
13+ dependencies. To install sgkit with PLINK support using pip::
14+
15+ $ pip install git+https://github.com/pystatgen/sgkit#egg=sgkit[plink]
16+
You can’t perform that action at this time.
0 commit comments