Skip to content

Commit dbaae94

Browse files
authored
cite which version of Fst; closes #858 (#3346)
1 parent f1b139e commit dbaae94

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

python/tskit/trees.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10051,6 +10051,11 @@ def Fst(
1005110051
What is computed for diversity and divergence depends on ``mode``;
1005210052
see those functions for more details.
1005310053
10054+
For ``mode='site'``, this definition of Fst appears as equation (6) in
10055+
`Slatkin (1991) <https://doi.org/10.1017/S0016672300029827>`_, and
10056+
is also found as equation (9) in
10057+
`Nei (1973) <https://doi.org/10.1073/pnas.70.12.3321>`_.
10058+
1005410059
:param list sample_sets: A list of lists of Node IDs, specifying the
1005510060
groups of nodes to compute the statistic with.
1005610061
:param list indexes: A list of 2-tuples.

0 commit comments

Comments
 (0)