Skip to content

Commit

Permalink
docs: describe ranks.tsv
Browse files Browse the repository at this point in the history
  • Loading branch information
tuner committed Jan 16, 2025
1 parent ed8eeb5 commit 84fa971
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,25 @@ table.
| P2_iOvaR1_DNA1 | 7 | 0.665 | P2 |
| P2_pOme2_DNA1 | 8 | 0.5195 | P2 |

### `ranks.tsv`

Ranks may have optional titles that are displayed above the sample column.

#### Columns

- `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.
- `title` (string): specifies the title for the rank.

#### Example

| rank | title |
| ---- | ------------ |
| 0 | Before diag. |
| 1 | Diagnosis |
| 2 | Diagnosis 2 |
| 3 | Interval |
| 4 | Relapse |

## About

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

0 comments on commit 84fa971

Please sign in to comment.