adds timeline plot example to README

awslabs · Aug 19, 2024 · 5d8460c · 5d8460c
1 parent 6e5ff29
commit 5d8460c
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -381,6 +381,16 @@ The CSV output by the command above includes the following columns:
 * __storageMaximumGiB__ : Maximum gibibytes of storage used during a single 1-minute interval
 * __storageAverageGiB__ : Average gibibytes of storage used by the workflow run
 
+#### Produce a timeline plot for a run
+
+The RunAnalyzer tool can produce an interative timeline plot of a workflow. The plots allow you to visualize how individual tasks ran over the course of the run.
+
+```bash
+python -m omics.cli.run_analyzer -P plots/ 7113639
+```
+
+![Example time line image showing stacked horizontal bars indicating the time taken by each task](./assets/timeline.png)
+
 #### Output workflow run manifest in JSON format
 
 ```bash

diff --git a/assets/timeline.png b/assets/timeline.png