Skip to content

Commit

Permalink
rename subclones.tsv to compositions.tsv
Browse files Browse the repository at this point in the history
  • Loading branch information
tuner committed Oct 2, 2024
1 parent 0dac88f commit 4ed9bc5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 6 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,9 @@ allows you to render Jellyfish plots based on your data.

## Input Data

Jellyfish reads data from the `data/` directory. Below is a description of the
data structure, with example files provided in the directory.
Jellyfish reads data as tab-separated files from the `data/` directory. Below is
a description of the data structure, with example files provided in the
directory.

To use your own data, it is recommended to place it in a separate directory,
such as `private-data/`, which is excluded from the Git repository. Then, create
Expand Down Expand Up @@ -145,10 +146,11 @@ containing a single patient, the `patient` (string) columns can be omitted.
| 7 | 6 | #fb9a99 | 137 | P2 |
| 8 | 4 | #bbbb77 | 462 | P2 |

### `subclones.tsv`
### `compositions.tsv`

Subclones are specified in a [tidy](https://vita.had.co.nz/papers/tidy-data.pdf)
format, where each row represents a subclone in a sample.
Subclonal compositions are specified in a
[tidy](https://vita.had.co.nz/papers/tidy-data.pdf) format, where each row
represents a subclone in a sample.

#### Columns

Expand Down
File renamed without changes.
2 changes: 1 addition & 1 deletion src/data.ts
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export async function loadAndParsePhylogeny(): Promise<PhylogenyRow[]> {
}

export async function loadAndParseCompositions(): Promise<CompositionRow[]> {
return (await fetchAndParse("subclones.tsv")).map((d) => ({
return (await fetchAndParse("compositions.tsv")).map((d) => ({
sample: d.sample as SampleId,
subclone: d.subclone as Subclone,
clonalPrevalence: +d.clonalPrevalence,
Expand Down

0 comments on commit 4ed9bc5

Please sign in to comment.