Skip to content

Commit

Permalink
DOC: Minor modification
Browse files Browse the repository at this point in the history
Minor modification to documentation.
  • Loading branch information
daikitag authored and mergify[bot] committed Feb 20, 2024
1 parent 0cd2752 commit 33ac5f4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ The simulated phenotypes can be scaled by using the {func}`normalise_phenotypes`
will first normalise the phenotype by subtracting the mean of the input phenotype from each
value and divide it by the standard devitation of the input phenotype.
Afterwards, it scales the normalised phenotype based on the mean and variance input.
The output of {func}`normalise_phenotype` is a {class}`pandas.DataFrame` object with the scaled phenotypes.
The output of {func}`normalise_phenotypes` is a {class}`pandas.DataFrame` object with the scaled phenotypes.

An example usage of this function is shown below:

Expand Down
3 changes: 3 additions & 0 deletions tstrait/simulate_phenotype.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,9 @@ def sim_phenotype(
Trait model that will be used to simulate effect sizes.
num_causal : int, default None
Number of causal sites. If None, number of causal sites will be 1.
causal_sites : list, default None
List of site IDs that have causal allele. If None, causal site IDs will be
chosen randomly according to num_causal.
alpha : float, default None
Parameter that determines the degree of the frequency dependence model. Please
see :ref:`frequency_dependence` for details on how this parameter influences
Expand Down

0 comments on commit 33ac5f4

Please sign in to comment.