nextflow-io / nextflow

A DSL for data-driven computational pipelines
http://nextflow.io
Apache License 2.0
2.74k stars 628 forks source link

Warning in documentation when a resource intensive task will occur on the 'head' node #4389

Open adamrtalbot opened 1 year ago

adamrtalbot commented 1 year ago

There are a number of methods that work on the Nextflow process and therefore, the head node. Since it is typically small, these can quickly overwhelm the machine and cause issues. This can be manifested as issues that seem to pop up here but never reach a satisfactory fix, because they are trying to solve a fundamentally bad thing to do ™️ .

We should add a warning to these documentations about limited resources and control and suggest developers use a script process instead.

Current list

bentsherman commented 1 year ago

All of these items except for the exec block have warnings about high memory usage. But I agree that a warning for the exec block would be good.

adamrtalbot commented 1 year ago

People are still trying to use them with massive files, in particular splitFastq because it's sooooo convenient. I think the wording needs to be stronger.

stale[bot] commented 7 months ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.