Skip to content

Commit 147d8cc

Browse files
committed
Update workflow visualizations
1 parent 2645f3e commit 147d8cc

4 files changed

Lines changed: 15 additions & 7 deletions

File tree

.dag.png

476 KB
Loading

.rulegraph.png

283 KB
Loading

.rulegraph_sv.svg

Lines changed: 1 addition & 0 deletions
Loading

config/README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -202,24 +202,31 @@ All of the following variables are pre-defined in [config.yaml](/config/config.y
202202
- `REPORT_QMD`: path of the report template in Quarto markdown (QMD) format.
203203
- `REPORT_CSS`: path of the report stylesheet definition in CSS format.
204204

205-
## Workflow graphs
205+
## Workflow visualization
206206

207-
To generate a simplified rule graph, run:
207+
Snakemake enables easy visualization of workflows and rule relationships. The `--rulegraph` option outputs a DOT file that describes dependencies between rules. The example below produces an image using Graphviz:
208208

209209
```shell
210-
snakemake --rulegraph | dot -Tpng > .rulegraph.png
210+
snakemake --forceall --rulegraph | dot -Tpng >.rulegraph.png
211211
```
212212

213213
![Snakemake rule graph](/.rulegraph.png)
214214

215-
To generate the directed acyclic graph (DAG) of all rules
216-
to be executed, run:
215+
The same graph can also be rendered with other tools such as [snakevision](https://github.com/OpenOmics/snakevision) (v0.1.0).
217216

218217
```shell
219-
snakemake --forceall --dag | dot -Tpng > .dag.png
218+
snakemake --forceall --rulegraph | snakevision -s all -o .rulegraph_sv.svg
220219
```
221220

222-
![Snakemake rule graph](/.dag.png)
221+
![Snakemake rule graph using snakevision](/.rulegraph_sv.svg)
222+
223+
The `--dag` option emits an directed acyclic graph (DAG) that corresponds to the rule instances that would be executed for the current dataset. The example below produces an image using Graphviz:
224+
225+
```shell
226+
snakemake --forceall --dag | dot -Tpng >.dag.png
227+
```
228+
229+
![Snakemake DAG](/.dag.png)
223230

224231
## Run modes
225232

0 commit comments

Comments
 (0)