@@ -10966,11 +10966,13 @@ def ld_matrix(
1096610966 in a square matrix (see :ref:`sec_stats_two_locus_branch` for
1096710967 examples).
1096810968
10969- Some LD statistics are defined for two sample sets instead of within a
10970- single set of samples. If the ``indexes`` argument is specified, at
10971- least two sample sets must also be specified. ``indexes`` specifies the
10972- indexes of the sample sets in the ``sample_sets`` list
10973- between which to compute LD.
10969+ Some LD statistics are defined for two sample sets as well as within a
10970+ single set of samples. If the ``indexes`` argument is specified, then
10971+ ``indexes`` specifies the indexes of the sample sets in the
10972+ ``sample_sets`` list between which to compute LD. For example, this
10973+ results in a 3D array whose ``[k,:,:]``-th slice contains LD values
10974+ between ``sample_sets[i]`` and ``sample_sets[j]``, where ``(i, j)`` is
10975+ the ``k``-th element of ``indexes``.
1097410976
1097510977 For more on how the ``indexes`` and ``sample_sets`` interact with the
1097610978 output dimensions, see the :ref:`sec_stats_two_locus_sample_sets`
@@ -10979,7 +10981,7 @@ def ld_matrix(
1097910981 **Available Stats** (use ``Stat Name`` in the ``stat`` keyword
1098010982 argument). Statistics marked as "multi sample set" allow
1098110983 (but do not require) computation from two sample sets
10982- via the ``indexes`` argument.
10984+ via the ``indexes`` argument.
1098310985
1098410986 ======================= ========== ================ ==============
1098510987 Stat Polarised Multi Sample Set Stat Name
@@ -10996,9 +10998,9 @@ def ld_matrix(
1099610998 :math:`\widehat{\pi_2}` n n "pi2_unbiased"
1099710999 ======================= ========== ================ ==============
1099811000
10999- :param list sample_sets: A list, or a list of lists of sample node IDs, specifying
11000- the groups of nodes to compute the statistic with. Defaults to all
11001- samples grouped by population .
11001+ :param list sample_sets: A list, or a list of lists of sample node IDs,
11002+ specifying the groups of nodes to compute the statistic with. Defaults
11003+ to all samples .
1100211004 :param str mode: A string giving the "type" of the statistic to be
1100311005 computed. Defaults to "site", can be "site" or "branch".
1100411006 :param str stat: A string giving the selected two-locus statistic to
0 commit comments