Skip to content

Commit

Permalink
Organise methods
Browse files Browse the repository at this point in the history
  • Loading branch information
benjeffery committed Nov 27, 2023
1 parent b5797eb commit 99a0c8f
Showing 1 changed file with 53 additions and 15 deletions.
68 changes: 53 additions & 15 deletions docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ Dataset
Methods
=======

Allele and Genotype Analysis
----------------------------

.. autosummary::
:toctree: generated/

Expand All @@ -95,34 +98,69 @@ Methods
count_cohort_alleles
count_variant_alleles
count_variant_genotypes
observed_heterozygosity
variant_stats

Population and Cohort Genetics
------------------------------

.. autosummary::
:toctree: generated/

divergence
diversity
Fst
Tajimas_D
Weir_Goudet_beta
Garud_H
genee
pbs

Pedigree and Relationship
------------------------

.. autosummary::
:toctree: generated/

genomic_relationship
gwas_linear_regression
hardy_weinberg_test
pc_relate
pedigree_contribution
pedigree_inbreeding
pedigree_inverse_kinship
pedigree_kinship
hybrid_inverse_relationship
hybrid_relationship
identity_by_state
individual_heterozygosity

Linkage Disequilibrium and Heterozygosity
-----------------------------------------

.. autosummary::
:toctree: generated/

ld_matrix
ld_prune
individual_heterozygosity

Genetic Association and Regression
----------------------------------

.. autosummary::
:toctree: generated/

gwas_linear_regression
regenie
hardy_weinberg_test
genee

Miscellaneous and Utilities
----------------------------

.. autosummary::
:toctree: generated/

maximal_independent_set
observed_heterozygosity
pairwise_distance
pbs
pedigree_contribution
pedigree_inbreeding
pedigree_inverse_kinship
pedigree_kinship
pc_relate
regenie
sample_stats
Tajimas_D
variant_stats
Weir_Goudet_beta

Utilities
=========
Expand Down

0 comments on commit 99a0c8f

Please sign in to comment.