Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
suecharo committed Jan 29, 2024
1 parent 42693ca commit 15790dd
Showing 1 changed file with 37 additions and 1 deletion.
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ Examples:

## How to prepare an RO-Crate for `Tonkaz`?

Tonkaz supports **ONLY** RO-Crate generated by [`Sapporo-service`](https://github.com/sapporo-wes/sapporo-service) (version 1.6.0 or newer) and [`Yevis-cli`](https://github.com/sapporo-wes/yevis-cli).
Tonkaz supports **ONLY** RO-Crate generated by [`Sapporo-service`](https://github.com/sapporo-wes/sapporo-service) (version 1.6.0 or newer) or [`Yevis-cli`](https://github.com/sapporo-wes/yevis-cli).
For more information about Sapporo and Yevis, please see these repositories.

The RO-Crate can be generated to pass the `--fetch-ro-crate` option to Yevis-cli's `test` command as follows:
Expand Down Expand Up @@ -117,6 +117,42 @@ run.pid start_time.txt yevis-metadata.yml
$ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v $PWD:$PWD -w $PWD ghcr.io/sapporo-wes/sapporo-service:latest python3 /app/sapporo/ro_crate.py $PWD
```

## Comparison of MultiQC Statistics (New Feature in 0.3.0)

Sapporo-service, from version 1.6.0 onwards, introduced a feature where MultiQC is executed after workflow completion, and its results are added to the RO-Crate.
Tonkaz can compare these MultiQC results.
MultiQC checks the workflow output, extracts units per sample, and aggregates statistical data from each tool for individual samples.

Previously, Tonkaz facilitated comparisons at the file level, but with the introduction of MultiQC comparison, it is now possible to compare at the sample level.
Please note that since it is difficult to handle file-level and sample-level comparisons in parallel, the MultiQC comparison is an additional feature.

However, this sample-level comparison is considered beneficial as it allows for more detailed comparison of workflow results.

An example of the comparison results is as follows:

```text
- Salmon Num_mapped
.--------------------------------------------------------------------------.
| Sample | in Crate1 | in Crate2 | Level |
|--------------------------------|--------------|--------------|-----------|
| RAP1_IAA_30M_REP1 | 38268 | 40165 | ⭐⭐ |
| RAP1_UNINDUCED_REP1 | 39317 | 39317 | ⭐⭐ |
| RAP1_UNINDUCED_REP2 | 78884 | 81361 | ⭐⭐ |
| WT_REP1 | 74109 | 74109 | ⭐⭐ |
| WT_REP2 | 37368 | 37368 | ⭐⭐ |
'--------------------------------------------------------------------------'
- Samtools Flagstat_total
.--------------------------------------------------------------------------.
| Sample | in Crate1 | in Crate2 | Level |
|--------------------------------|--------------|--------------|-----------|
| RAP1_IAA_30M_REP1 | 94912 | 94912 | ⭐⭐ |
| RAP1_UNINDUCED_REP1 | 49040 | 49040 | ⭐⭐ |
| RAP1_UNINDUCED_REP2 | 98338 | 98338 | ⭐⭐ |
| WT_REP1 | 188243 | 188241 | ⭐⭐ |
| WT_REP2 | 94419 | 94419 | ⭐⭐ |
'--------------------------------------------------------------------------'
## Development
We use [Deno](https://deno.land/) `v1.40.2`.
Expand Down

0 comments on commit 15790dd

Please sign in to comment.