Skip to content

Commit ace20a0

Browse files
authored
Merge pull request #224 from nf-core/doc-update-workdir
Added reference to `-work-dir`
2 parents 731e2da + 6849b87 commit ace20a0

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

docs/usage.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -280,6 +280,9 @@ Additionally, EAGER pipeline releases are named after Swabian German Cities. The
280280
### `--outdir`
281281
The output directory where the results will be saved.
282282

283+
### `-work-dir`
284+
The output directory where the intermediate files (stored in `work/`) will be saved. If this flag is _not_ provided, the `work/` directory will be place wherever you initated the nextflow run. We generally recommend that this directory should the same as in the `--outdir` flag, to ensure multiple nextflow runs are kept separate.
285+
283286
### `--max_memory`
284287
Use to set a top-limit for the default memory requirement for each process.
285288
Should be a string in the format integer-unit. eg. `--max_memory '8.GB'`. If not specified, will be taken from the configuration in the `-profile` flag.

0 commit comments

Comments
 (0)