Skip to content

Commit e4f1aff

Browse files
committed
docs: update readme
1 parent fa0893f commit e4f1aff

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,49 @@ trajectories characterized by distinct pathways stratify patients with ovarian
88
high-grade serous carcinoma." _Cancer Cell_ **41**, 1103–1117.e12 (2023). DOI:
99
[10.1016/j.ccell.2023.04.017](https://doi.org/10.1016/j.ccell.2023.04.017).
1010

11-
The documentation is a work in progress.
11+
You can explore the tool and example data at
12+
[https://hautaniemilab.github.io/jellyfish/](https://hautaniemilab.github.io/jellyfish/).
13+
14+
The documentation is still a work in progress.
1215

1316
<p align="center">
1417
<img src="docs/example.svg" alt="Example Jellyfish plot" />
1518
</p>
1619

20+
## Basic Concepts
21+
22+
A Jellyfish plot visualizes the evolution of a tumor by showing the subclonal
23+
composition of samples in a phylogenetic context. The plot combined two trees
24+
into a single visualization: a **phylogeny** and a **sample tree**.
25+
26+
The phylogeny is a tree structure that represents the evolutionary relationships
27+
between subclones. Each subclone is a distinct population of cells with a unique
28+
set of genetic mutations.
29+
30+
The samples represent the observed data points, which may be tumor samples from
31+
a patient, each with a unique combination subclones with specific clonal
32+
prevalences, i.e. the proportions of the subclones. The sample tree is a tree
33+
structure that represents the relationships between samples. The relationships
34+
may be based, for example, on the hypothesized metastatic spread of the tumor or
35+
the chronological order of the samples. Each sample has a rank, which is a
36+
numerical value that determines the position (the column) of the sample in the
37+
plot. The rank can be used to group samples into categories or timepoints, such
38+
as different stages of a disease. Alternatively, the rank may automatically
39+
assigned, based on the depth of the sample in the sample tree.
40+
41+
The Jellyfish algorithm optimizes the readability of the visualization by
42+
pushing the emerging subclones towards the leaves of the sample tree. In
43+
practice, Jellyfish finds the [Lowest Common
44+
Ancestor](https://en.wikipedia.org/wiki/Lowest_common_ancestor) (LCA) of each
45+
cluster (a subclone and all its descendants) in the sample tree. The LCA is
46+
visualized as an emerging bell, indicating where the subclone first appears in
47+
the sample tree.
48+
49+
Each sample without an explicit parent is considered a child of the _inferred
50+
root_ sample. It is a virtual or hypothetical sample that is used to anchor the
51+
phylogeny to the sample tree, i.e., it serves as a host for the LCAs of the
52+
subclones that have been observed in multiple real samples.
53+
1754
## Getting started
1855

1956
Jellyfish Plotter is a web application written in JavaScript. You need to have

0 commit comments

Comments
 (0)