Skip to content

Commit 328fe36

Browse files
hyanwongmergify[bot]
authored andcommitted
Minor usage documentation tidying
1 parent 35c8b6a commit 328fe36

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/usage.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@ for site_id, pos in enumerate(positions):
6262
```
6363

6464
:::{note}
65-
The last site, at position 95, is an indel (insertion or deletion). Indels can be used as long as the indel does not overlap with other variants, only 2 alleles exist, and the ancestral state is known.
65+
The last site, at position 95, is an indel (insertion or deletion). Indels can be used
66+
for inference as long as the indel does not overlap with other variants, only 2
67+
alleles exist, and the ancestral state is known.
6668
:::
6769

6870
### VariantData and ancestral alleles
@@ -203,13 +205,14 @@ inferred_ts.draw_svg(
203205
)
204206
```
205207

206-
We have inferred 4 trees aong the genome. Note, however, that there are "polytomies" in the
208+
We have inferred 4 trees along the genome. Note that there are "polytomies" in the
207209
trees, where some nodes have more than two children (e.g. the root node in the first tree).
208210
This is a common feature of trees inferred by _tsinfer_ and signals that there was not
209-
sufficient information to resolve the tree at this internal node.
211+
sufficient information to resolve the tree at this internal node. By default, the ancestry
212+
in the flanking regions (to the left of the first provided site and the right of the last provided site) is considered {ref}`unknown<tskit:sec_data_model_missing_data>`, and hence not drawn above.
210213

211214

212-
Each internal (non-sample) node in this inferred tree represents an ancestral sequence,
215+
Each internal (non-sample) node in this inferred genealogy represents an ancestral sequence,
213216
constructed on the basis of shared, derived alleles at one or more of the sites. By
214217
default, the time of each such node is *not* measured in years or generations, but
215218
is simply the frequency of the shared derived allele(s) on which the ancestral sequence

0 commit comments

Comments
 (0)