Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Update API #81

Merged
merged 1 commit into from
Aug 25, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
103 changes: 83 additions & 20 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Loading