Skip to content

Commit c180755

Browse files
Merge pull request #194 from hyanwong/new-sec
Mention the new omit_sites param
2 parents eedb652 + 2b8f1c2 commit c180755

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

viz.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -295,11 +295,12 @@ ts_full.first().draw_svg(
295295

296296
### Plotting mutations
297297

298-
The SVG visualization also allows mutations to displayed on the tree or tree sequence.
299-
Here are the same plots as above but where the tree sequence now contains mutations. Each
300-
mutation is plotted as a red cross on the branch where it occurs. This mutation symbol is
301-
placed either at the mutation's known time, or spaced evenly along the branch (if the
302-
mutation time is unknown or the `time_scale` parameter has been set to `"rank"`).
298+
By default the SVG visualization also plots sites and mutations on the tree or
299+
tree sequence (this can be disabled using the `omit_sites` parameter). For example,
300+
adding mutations to the 8-sample tree sequence above gives the following plot: each
301+
mutation is marked by a red cross on the branch where it occurs. Symbols are
302+
either placed at the mutation's known time, or (if the mutation time is unknown or
303+
the `time_scale` parameter has been set to `"rank"`) spaced evenly along the branch.
303304
By default, each mutation is also labelled with its {class}`mutation ID<tskit.Mutation>`.
304305

305306
If the X axis is shown (which it is by default when drawing a tree sequence, but not

0 commit comments

Comments
 (0)