Skip to content

Commit 6b9da0e

Browse files
Update python/tskit/trees.py
Co-authored-by: Peter Ralph <petrel.harp@gmail.com>
1 parent 2ad3a81 commit 6b9da0e

1 file changed

Lines changed: 5 additions & 4 deletions

File tree

python/tskit/trees.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10956,10 +10956,11 @@ def ld_matrix(
1095610956
:ref:`sec_stats_two_locus_site` for examples).
1095710957
1095810958
Similarly, in the branch mode, the ``positions`` argument specifies
10959-
loci for which the expectation for the two-locus statistic is computed
10960-
over pairs of trees at those positions. LD stats are computed between
10961-
trees whose ``[start, end)`` contains the given position (such that
10962-
repeats of trees are possible). Similar to the site mode, a nested list
10959+
genomic coordinates at which the expectation for the two-locus statistic
10960+
is computed, given the local tree structure. This defaults to computing
10961+
the LD for each pair of distinct trees, which is equivalent to passing in
10962+
the leftmost coordinates of each tree's span (since intervals are closed on
10963+
the left and open on the right). Similar to the site mode, a nested list
1096310964
of row and column positions can be specified separately (resulting in a
1096410965
rectangular matrix) or a single list of a specified positions results
1096510966
in a square matrix (see :ref:`sec_stats_two_locus_branch` for

0 commit comments

Comments
 (0)