diff --git a/docs/ibd.md b/docs/ibd.md index d52b9d345c..776ca980b6 100644 --- a/docs/ibd.md +++ b/docs/ibd.md @@ -337,10 +337,13 @@ of what's stored in the tree sequence. As discussed in [Fritze et al](https://doi.org/10.1093/genetics/iyaf198), most tree sequence simulators (at time of writing) -will produce this tree sequence even if node ``2`` +will produce this tree sequence by default, even if node ``2`` does in fact inherit from ``3`` over the entire sequence. -Using {meth}`.TreeSequence.extend_haplotypes` will -"put the unary nodes back": +For the [msprime](https://tskit.dev/msprime/) simulator, intermediate +nodes can be retained using +{ref}`coalescing_segments_only=False`. +More generally, {meth}`.TreeSequence.extend_haplotypes` will +attempt to "put the unary nodes back": ```{code-cell} ets = ts.extend_haplotypes() SVG(ets.draw_svg()) diff --git a/docs/stats.md b/docs/stats.md index 709bf2ee6c..61c9cf29b4 100644 --- a/docs/stats.md +++ b/docs/stats.md @@ -53,15 +53,19 @@ Here are the statistics that can be computed using `tskit`, grouped by basic classification and type. Single-site statistics are ones that are averages across sites in windows of the genome, returning numpy arrays whose dimensions are determined by the parameters (see {ref}`sec_stats_output_dimensions`). +Multi-site statistics summarize relationships between different sites along the genome, +such as linkage disequilibium (LD). -{ref}`sec_stats_sample_sets_one_way` are defined over a single sample set, -whereas {ref}`sec_stats_sample_sets_multi_way` compare 2 or more sets of samples. +Both single and multi-site approaches require specifying the sample genomes on which +a statistic is based. {ref}`sec_stats_sample_sets_one_way` are defined over a single +sample set, whereas {ref}`sec_stats_sample_sets_multi_way` compare 2 or more sets +of samples. Some of the methods below benefit from a little extra discussion, provided in the {ref}`sec_stats_notes` section at the end of this chapter: if so, a link to the note appears beside the listed method. -* Single site +* {ref}`Single site` * One-way * {meth}`~TreeSequence.allele_frequency_spectrum` (see {ref}`notes`) * {meth}`~TreeSequence.diversity` @@ -86,8 +90,8 @@ appears beside the listed method. (see {ref}`sec_stats_notes_y`) * {meth}`~TreeSequence.genealogical_nearest_neighbours` (see {ref}`sec_stats_notes_gnn`) * {meth}`~TreeSequence.Fst` (see {ref}`sec_stats_notes_derived`) -* Multi site - * {meth}`~LdCalculator` (note this is soon to be deprecated) +* {ref}`Multi site` + * {meth}`~TreeSequence.ld_matrix` (see {ref}`sec_stats_two_locus`) :::{note} There is a general framework provided for calculating additional single site