From c3e8377634c1f3131ffc0bdc2e8d2d219a73b68c Mon Sep 17 00:00:00 2001 From: daikitag <48062118+daikitag@users.noreply.github.com> Date: Fri, 25 Aug 2023 23:01:59 +0900 Subject: [PATCH] Update api.md Update api.md --- docs/api.md | 103 ++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 83 insertions(+), 20 deletions(-) diff --git a/docs/api.md b/docs/api.md index b00f9e2..d44e7fb 100644 --- a/docs/api.md +++ b/docs/api.md @@ -8,42 +8,105 @@ This page provides a detailed explanation of all public tstrait objects and functions. -## Simulation functions +## Summary + +### Simulation functions ```{eval-rst} .. autosummary:: - :toctree: _api - sim_phenotype - sim_trait - sim_genetic - sim_env + sim_phenotype + sim_trait + sim_genetic + sim_env ``` (effect_size_distribution)= -## Effect size distributions +### Effect size distributions ```{eval-rst} .. autosummary:: - :toctree: _api - trait_model - TraitModel - TraitModelNormal - TraitModelT - TraitModelFixed - TraitModelExponential - TraitModelGamma - TraitModelMultivariateNormal + trait_model + TraitModel + TraitModelNormal + TraitModelT + TraitModelFixed + TraitModelExponential + TraitModelGamma + TraitModelMultivariateNormal ``` -## Result data classes +### Result data classes ```{eval-rst} .. autosummary:: - :toctree: _api - PhenotypeResult - GeneticResult + PhenotypeResult + GeneticResult +``` + +## Reference documentation + +### Simulation functions + +```{eval-rst} +.. autofunction:: tstrait.sim_phenotype +``` + +```{eval-rst} +.. autofunction:: tstrait.sim_trait +``` + +```{eval-rst} +.. autofunction:: tstrait.sim_genetic +``` + +```{eval-rst} +.. autofunction:: tstrait.sim_env +``` + +### Effect size distributions + +```{eval-rst} +.. autofunction:: tstrait.trait_model +``` + +```{eval-rst} +.. autoclass:: tstrait.TraitModel +``` + +```{eval-rst} +.. autoclass:: tstrait.TraitModelNormal +``` + +```{eval-rst} +.. autoclass:: tstrait.TraitModelT +``` + +```{eval-rst} +.. autoclass:: tstrait.TraitModelFixed +``` + +```{eval-rst} +.. autoclass:: tstrait.TraitModelExponential +``` + +```{eval-rst} +.. autoclass:: tstrait.TraitModelGamma +``` + +```{eval-rst} +.. autoclass:: tstrait.TraitModelMultivariateNormal +``` + +### Result data classes + +```{eval-rst} +.. autoclass:: tstrait.PhenotypeResult +``` + +```{eval-rst} +.. autoclass:: tstrait.GeneticResult ```