From 2fce2fe62b9f8789c92ddba716cb78826148db51 Mon Sep 17 00:00:00 2001 From: "James A. Fellows Yates" Date: Fri, 29 Mar 2019 10:41:53 +0100 Subject: [PATCH 1/2] Added cleanup paragraph --- docs/usage.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/usage.md b/docs/usage.md index 10dcc0434..23b7713c1 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -10,7 +10,7 @@ * [Other command line parameters](#other-command-line-parameters) * [Adjustable parameters for nf-core/eager](#adjustable-parameters-for-nf-coreeager) * [Automatic resubmission](#automatic-resubmission) - +* [Clean up](#clean-up) ## General Nextflow info 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 ## Automatic Resubmission 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. + +## Clean up + +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`. + +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. + +> **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. + +While in your output directory, firstly verify you're only deleting files stored in `work/` with the dry run command: + +```bash +nextflow clean -n +``` +If you're ready, you can then remove the files with + +```bash +nextflow clean -f +``` + +This will make your system administrator very happy, so be sure to do this! From 773f8b28037259c77f404888a859a0d71084e99a Mon Sep 17 00:00:00 2001 From: "James A. Fellows Yates" Date: Fri, 29 Mar 2019 10:45:52 +0100 Subject: [PATCH 2/2] Provide exampe clean up stat --- docs/usage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/usage.md b/docs/usage.md index 23b7713c1..05bdb36bb 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -522,4 +522,4 @@ If you're ready, you can then remove the files with nextflow clean -f ``` -This will make your system administrator very happy, so be sure to do this! +This will make your system administrator very happy as you will _halve_ the harddrive footprint of the run, so be sure to do this!