Skip to content

Commit 2fce2fe

Browse files
authored
Added cleanup paragraph
1 parent 9aa0d64 commit 2fce2fe

1 file changed

Lines changed: 22 additions & 1 deletion

File tree

docs/usage.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
* [Other command line parameters](#other-command-line-parameters)
1111
* [Adjustable parameters for nf-core/eager](#adjustable-parameters-for-nf-coreeager)
1212
* [Automatic resubmission](#automatic-resubmission)
13-
13+
* [Clean up](#clean-up)
1414

1515
## General Nextflow info
1616
Nextflow handles job submissions on SLURM or other environments, and supervises running the jobs. Thus the Nextflow process must run until the pipeline is finished. We recommend that you put the process running in the background through `screen` / `tmux` or similar tool. Alternatively you can run nextflow within a cluster job submitted your job scheduler.
@@ -502,3 +502,24 @@ Can be used to set a path to a BED file (3/6 column format) to calculate capture
502502

503503
## Automatic Resubmission
504504
By default, if a pipeline step fails, EAGER2 will resubmit the job with twice the amount of CPU and memory. This will occur two times before failing.
505+
506+
## Clean up
507+
508+
Once completed a run has completed, you will have _lots_ of (some very large) intermediate files in your output directory, within the directory named `work`.
509+
510+
Once you have verified your run completed correctly and everything in the module output directories are present as you expect and need, you can perform a clean up.
511+
512+
> **Important**: Once clean up is completed, you will _not_ be able to re-rerun the pipline from an earlier step and you'll have to re-run from scratch.
513+
514+
While in your output directory, firstly verify you're only deleting files stored in `work/` with the dry run command:
515+
516+
```bash
517+
nextflow clean -n
518+
```
519+
If you're ready, you can then remove the files with
520+
521+
```bash
522+
nextflow clean -f
523+
```
524+
525+
This will make your system administrator very happy, so be sure to do this!

0 commit comments

Comments
 (0)