Skip to content

Commit ece62a9

Browse files
committed
Add a bit more about polarization
1 parent 0c0fb29 commit ece62a9

1 file changed

Lines changed: 7 additions & 3 deletions

File tree

docs/stats.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -702,9 +702,13 @@ similarly to most other functions with respect to `sample_sets` and `indexes`.
702702

703703
Two-locus statistics can be computed using two modes, either `site` or
704704
`branch`, and these should be interpreted in the same way as these modes in the
705-
single-site statistics. Within this framework, we also implement polarisation,
706-
but do not expose it to the user, opting to provide statistics that are
707-
polarised where appropriate.
705+
single-site statistics. Within this framework, statistics may be either
706+
polarised or unpolarised. For statistics that are polarised, we compute
707+
statistic values for pairs of derived alleles. Unpolarised statistics compute
708+
statistics over all possible alleles, derived and ancestral, and the result in
709+
averaged over statistics computed for all pairs of alleles (see weighting
710+
schemes below). The option for polarisation is not exposed to the user.
711+
Instead, we implement statistics that are polarised where appropriate.
708712

709713
(sec_stats_two_locus_site)=
710714

0 commit comments

Comments
 (0)