Skip to content

Commit 84fa971

Browse files
committed
docs: describe ranks.tsv
1 parent ed8eeb5 commit 84fa971

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -227,6 +227,25 @@ table.
227227
| P2_iOvaR1_DNA1 | 7 | 0.665 | P2 |
228228
| P2_pOme2_DNA1 | 8 | 0.5195 | P2 |
229229

230+
### `ranks.tsv`
231+
232+
Ranks may have optional titles that are displayed above the sample column.
233+
234+
#### Columns
235+
236+
- `rank` (integer): specifies the rank number. The zeroth rank is reserved for the inferred root of the sample tree. However, you are free to define a title for it.
237+
- `title` (string): specifies the title for the rank.
238+
239+
#### Example
240+
241+
| rank | title |
242+
| ---- | ------------ |
243+
| 0 | Before diag. |
244+
| 1 | Diagnosis |
245+
| 2 | Diagnosis 2 |
246+
| 3 | Interval |
247+
| 4 | Relapse |
248+
230249
## About
231250

232251
Copyright (c) 2024 Kari Lavikka. MIT licensed, see [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)