From 75a544ba528b30b43b861abc0ad464db4d6ae16f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Johannes=20K=C3=B6ster?= Date: Tue, 21 Sep 2021 17:51:04 +0200 Subject: [PATCH] docs: move note --- docs/tutorial/basics.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/tutorial/basics.rst b/docs/tutorial/basics.rst index be028a3ef..e22cdffe1 100644 --- a/docs/tutorial/basics.rst +++ b/docs/tutorial/basics.rst @@ -113,6 +113,10 @@ In other words, Snakemake will replace ``{input}`` with ``data/genome.fa data/sa The shell command invokes ``bwa mem`` with reference genome and reads, and pipes the output into ``samtools`` which creates a compressed `BAM `_ file containing the alignments. The output of ``samtools`` is redirected into the output file defined by the rule with ``>``. +.. sidebar:: Note + + It is best practice to have subsequent steps of a workflow in separate, unique, output folders. This keeps the working directory structured. Further, such unique prefixes allow Snakemake to quickly discard most rules in its search for rules that can provide the requested input. This accelerates the resolution of the rule dependencies in a workflow. + When a workflow is executed, Snakemake tries to generate given **target** files. Target files can be specified via the command line. By executing @@ -246,10 +250,6 @@ When issuing you will see how Snakemake wants to run first the rule ``bwa_map`` and then the rule ``samtools_sort`` to create the desired target file: as mentioned before, the dependencies are resolved automatically by matching file names. -.. sidebar:: Note - - It is best practice to have subsequent steps of a workflow in separate, unique, output folders. This keeps the working directory structured. Further, such unique prefixes allow Snakemake to quickly discard most rules in its search for rules that can provide the requested input. This accelerates the resolution of the rule dependencies in a workflow. - Step 4: Indexing read alignments and visualizing the DAG of jobs ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::