Skip to content

Commit

Permalink
Add edges page description for docs
Browse files Browse the repository at this point in the history
  • Loading branch information
savitakartik committed Oct 25, 2024
1 parent cc4b81b commit 8037e1a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
12 changes: 10 additions & 2 deletions docs/edges.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

# Edges page

TODO! Explain page
![Edges Page](tsbrowse:example.tsbrowse:edges)

![Edges Page](tsbrowse:example.tsbrowse:edges)
An edge represents the relationship between a pair of nodes (parent, child) in the ARGs over time (assigning the node occurring in more recent time as the child).

The interactive plot on the top row allows us to visualise these relationships as horizontal lines denoting the length of the edge on the sequence (X-axis) and time of one of the nodes (Y-axis). On mouse-over of an individual edge, the tool-tip displays the parent and child node IDs, length of sequence the edge spans, and the amount of time it spans (branch length).

The bottom panel contains three static histograms which. left to right, summarise the span of edges over the sequence, the span of edges over times (branch lengths), and the product of the two spans.

Plot controls (sidebar):
The 'log y-axis' checkbox plots node time on log scale.
The checkbox group allows switching between the nodes represented on the Y-axis (parent or child).
3 changes: 2 additions & 1 deletion tsbrowse/pages/mutations.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,11 @@ def make_muts_panel(log_y, tsm):
width=plot_width,
height=config.PLOT_HEIGHT,
color="num_inheritors",
cmap="winter",
cmap="viridis",
colorbar_position="left",
clabel="inheritors",
tools=[hover_tool, "tap"],
backend_opts={"plot.border_fill_color": "white"}
)

range_stream = hv.streams.RangeXY(source=points)
Expand Down

0 comments on commit 8037e1a

Please sign in to comment.