Skip to content

Commit

Permalink
add example output and benchmark repo link to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jaleezyy committed Jul 23, 2024
1 parent 7ee52fc commit 9829f8c
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ If you use this software please [cite](https://doi.org/10.3390/v12080895):
- [Run using Docker](#docker)
- [Data summaries](#data-summaries)
- [Pipeline details](#pipeline-details)
- [Example data and benchmarking](#example-output-and-benchmarking)

## Setup:

Expand Down Expand Up @@ -415,6 +416,11 @@ Flags:

The script uses `rsync` to provide accurate copies of select output files organized into `signal-results` and `ncov-tools-results` within a provided destination directory (that must exist). If the `-c` is provided, `cp` will be used instead of `rsync` to produce copies. Similarly, if `-m` is provided, `mv` will be used instead (**WARNING: Any interruption during `mv` could result in data loss.**)

## Example output and benchmarking

To view standalone example output in addition to results from standardized benchmarking, please see the following [repo](https://github.com/jaleezyy/signal-example-data).


## Pipeline details:

For a step-by-step walkthrough of the pipeline, see [pipeline/README.md](PIPELINE.md).
Expand Down

0 comments on commit 9829f8c

Please sign in to comment.