Skip to content

Commit de3c21c

Browse files
authored
docs: update workflow graph images (#40)
* docs: use SVG files to illustrate workflow graphs * docs: rotate snakemake graphs * docs: use details tag for rule graph images
1 parent 8025462 commit de3c21c

6 files changed

Lines changed: 4609 additions & 6 deletions

File tree

.dag.png

-966 KB
Binary file not shown.

.dag.svg

Lines changed: 3435 additions & 0 deletions
Loading

.rulegraph.png

-521 KB
Binary file not shown.

.rulegraph.svg

Lines changed: 1153 additions & 0 deletions
Loading

.rulegraph_sv.svg

Lines changed: 1 addition & 1 deletion
Loading

config/README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -207,26 +207,41 @@ All of the following variables are pre-defined in [config.yaml](/config/config.y
207207
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 --forceall --rulegraph | dot -Tpng >.rulegraph.png
210+
snakemake --forceall --rulegraph | dot -Grankdir=LR -Tsvg >.rulegraph.svg
211211
```
212212

213-
![Snakemake rule graph](/.rulegraph.png)
213+
<details>
214+
<summary>Rule graph image</summary>
215+
216+
![Snakemake rule graph](/.rulegraph.svg)
217+
218+
</details>
214219

215220
The same graph can also be rendered with other tools such as [snakevision](https://github.com/OpenOmics/snakevision) (v0.1.0).
216221

217222
```shell
218223
snakemake --forceall --rulegraph | snakevision -s all -o .rulegraph_sv.svg
219224
```
220225

226+
<details>
227+
<summary>Snakevision rule graph image</summary>
228+
221229
![Snakemake rule graph using snakevision](/.rulegraph_sv.svg)
222230

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:
231+
</details>
232+
233+
The `--dag` option emits an directed acyclic graph (DAG) that corresponds to the rule instances that would be executed for the target dataset. The example below produces an image using Graphviz (for [data](https://doi.org/10.20350/digitalCSIC/15648) from [our study](https://doi.org/10.1093/ve/veae018)):
224234

225235
```shell
226-
snakemake --forceall --dag | dot -Tpng >.dag.png
236+
snakemake --forceall --dag | dot -Grankdir=LR -Tsvg >.dag.svg
227237
```
228238

229-
![Snakemake DAG](/.dag.png)
239+
<details>
240+
<summary>DAG image</summary>
241+
242+
![Snakemake DAG](/.dag.svg)
243+
244+
</details>
230245

231246
## Run modes
232247

0 commit comments

Comments
 (0)