Skip to content

Commit af2b623

Browse files
Update diversity definition (#1328)
Just updating the documentation of the diversity() function in popgen.py to clarify that diversity is the mean number of differences between a pair of sequences, as opposed to other diversity estimators.
1 parent 72f7588 commit af2b623

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

sgkit/stats/popgen.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ def diversity(
2929
cohort_allele_count: Hashable = variables.cohort_allele_count,
3030
merge: bool = True,
3131
) -> Dataset:
32-
"""Compute diversity from cohort allele counts.
32+
"""Compute diversity as the average number of differences between a pair of sequences from cohort allele counts.
3333
3434
By default, values of this statistic are calculated per variant.
3535
To compute values in windows, call :func:`window_by_position` or :func:`window_by_variant` before calling

0 commit comments

Comments
 (0)