Skip to content

Commit 298fbbc

Browse files
benjefferymergify[bot]
authored andcommitted
Organise methods
1 parent 070e476 commit 298fbbc

File tree

1 file changed

+54
-16
lines changed

1 file changed

+54
-16
lines changed

docs/api.rst

Lines changed: 54 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,9 @@ Dataset
8686
Methods
8787
=======
8888

89+
Basic genetics statistics
90+
-------------------------
91+
8992
.. autosummary::
9093
:toctree: generated/
9194

@@ -95,34 +98,69 @@ Methods
9598
count_cohort_alleles
9699
count_variant_alleles
97100
count_variant_genotypes
101+
variant_stats
102+
sample_stats
103+
104+
Population genetic statistics
105+
-----------------------------
106+
107+
.. autosummary::
108+
:toctree: generated/
109+
98110
divergence
99111
diversity
100112
Fst
101113
Garud_H
102-
genee
103-
genomic_relationship
104-
gwas_linear_regression
105-
hardy_weinberg_test
106-
hybrid_inverse_relationship
107-
hybrid_relationship
108-
identity_by_state
109114
individual_heterozygosity
110-
ld_matrix
111-
ld_prune
112-
maximal_independent_set
113115
observed_heterozygosity
114-
pairwise_distance
115116
pbs
117+
Tajimas_D
118+
119+
Relatedness
120+
-----------
121+
122+
.. autosummary::
123+
:toctree: generated/
124+
125+
Weir_Goudet_beta
126+
genomic_relationship
127+
pc_relate
116128
pedigree_contribution
117129
pedigree_inbreeding
118130
pedigree_inverse_kinship
119131
pedigree_kinship
120-
pc_relate
132+
hybrid_inverse_relationship
133+
hybrid_relationship
134+
identity_by_state
135+
136+
Linkage Disequilibrium
137+
----------------------
138+
139+
.. autosummary::
140+
:toctree: generated/
141+
142+
ld_matrix
143+
ld_prune
144+
145+
Genetic Association and Regression
146+
----------------------------------
147+
148+
.. autosummary::
149+
:toctree: generated/
150+
151+
gwas_linear_regression
121152
regenie
122-
sample_stats
123-
Tajimas_D
124-
variant_stats
125-
Weir_Goudet_beta
153+
hardy_weinberg_test
154+
genee
155+
156+
Miscellaneous
157+
-------------
158+
159+
.. autosummary::
160+
:toctree: generated/
161+
162+
maximal_independent_set
163+
pairwise_distance
126164

127165
Utilities
128166
=========

0 commit comments

Comments
 (0)