Skip to content

Commit

Permalink
Update pipeline.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
vyepez88 authored and nickhsmith committed Dec 16, 2022
1 parent d147e68 commit 5cf018c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/source/pipeline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,16 +109,16 @@ To complete your update, you must run the following to get your local directory
Skipping recomputation of files
+++++++++++++++++++++++++++++++

If snakemake is interrupted and restarted, it will continue with the last unsuccessful job in the job graph. If a script is updated with minor change, e.g. when calling ``drop update``, all jobs of the modified script and its downstream steps will be rerun. However, in some cases one might want to keep the intermediate files instead and continue with the missing files. In order to do so, first execute
If the pipeline is interrupted and restarted, it will continue with the last unsuccessful job in the job graph. If a script is updated with minor change, e.g. when calling ``drop update``, all the jobs of the modified script and its downstream steps will be rerun. However, in some cases one might want to keep the intermediate files instead and continue with the missing files. In order to do so, first execute

.. code-block:: bash
snakemake <rule> --touch
for whichever rule or module you want to continue the computation. The ``--touch`` command touches all output files required by the pipeline that have already been computed. Omitting the rule will lead to accessing the complete pipeline. Afterwards, use
for whichever rule or module you want to continue the computation. The ``--touch`` command touches all output files required by the pipeline that have already been computed. Omitting the rule will lead to accessing the complete pipeline. Afterwards, run

.. code-block:: bash
snakemake unlock
to unlock the submodules, so that the jobs that need to be computed can be identified.
Overall, we recommend reading the snakemake documentation for further fine-tuning of the execution.

0 comments on commit 5cf018c

Please sign in to comment.