Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

"dry run" option? #844

Open
jemunro opened this issue Aug 23, 2018 · 15 comments · May be fixed by #4214
Open

"dry run" option? #844

jemunro opened this issue Aug 23, 2018 · 15 comments · May be fixed by #4214

Comments

@jemunro
Copy link

jemunro commented Aug 23, 2018

When using the -resume option, it would be helpful to see which processes are going to be run and which will be reused from the cache.
Additionally it would be useful to indicate which hashes have changed requiring a cached process to be run. I know this can be done manually with the -dump-hashes option but this is not very user friendly.

@pditommaso
Copy link
Member

Yes, it could have sense to have a kind of dry-run showing the which cached tasks would be used.

@fmorency
Copy link

fmorency commented Jan 7, 2019

+1! Would be super useful!

@blacky0x0
Copy link

blacky0x0 commented Feb 20, 2019

Just thoughts.
Dry-run or plan should be used to produce the full graph structure or just a part of DAG in text or UI mode. It should use fail-fast behavior while constructing AST. The parts of AST can be validated by json schema validator as a workaround.

nextflow plan -target=process.1A_prepare_genome_samtools
nextflow plan -target=module.'rnaseq.nf'.fastqc

@stevekm
Copy link
Contributor

stevekm commented Jan 14, 2020

was this ever implemented?

@kopardev
Copy link

Is dry-run or plan feature available in the latest nexflow version?

@stale
Copy link

stale bot commented Apr 27, 2020

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.

@stale stale bot added the wontfix label Apr 27, 2020
@pditommaso pditommaso added stale and removed wontfix labels Apr 27, 2020
@jimhavrilla
Copy link

Would still love this

@stale stale bot removed the stale label Jun 25, 2020
@stale
Copy link

stale bot commented Nov 23, 2020

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.

@stale stale bot added the stale label Nov 23, 2020
@pditommaso
Copy link
Member

Nextflow now supports the ability to simulate the execution using command stubs. See #1774.

More here https://www.nextflow.io/docs/edge/process.html#stub

@nick-youngblut
Copy link
Contributor

@pditommaso a stub run does not cover the following situation, correct? The situation:

  • The pipeline developer runs their Nextflow pipeline (e.g., large-scale requiring large amounts of compute resources & time)
  • The pipeline dies much of the way through the run (e.g., after days of running) due to an error in one step of the code (e.g., the code didn't scale to 10's of 1000's of files)
  • The pipeline developer modifies the code
  • The pipeline developer wants to know which parts of the pipeline will be re-run as a result of the code modification

I'm in that current situation, and I'm afraid that my modification will restart the pipeline from (near) the beginning, which means a loss of days and $$. I believe that a stub run must start from the beginning, and will thus not show me whether my modifications will result in a (near complete) restart of my pipeline run.

I migrated to Nextflow from Snakemake, and the --dryrun feature of Snakemake has helped me many times to avoid needless computation. It would be great to have the same functionality in Nextflow.

@guarelin
Copy link

I want to bump the feature-request for dry-runs as a previous Snakemake user.

In the meantime, if nextflow were to output the reason for reruns that would also be helpful. Snakemake has a reason for every rule.

@bentsherman bentsherman linked a pull request Aug 24, 2023 that will close this issue
@bentsherman
Copy link
Member

I took a first pass at implementing the most recent suggestions in this thread. Namely, resume a pipeline and determine which tasks would be re-executed, without actually executing them.

Feel free to test the linked PR. Basically run a pipeline with -dry-run and it will resume, print every task that is re-executed, then exit.

I think it could be improved by showing also the reason why a task is executed -- no cache entry found, cache folder found but outputs are missing, etc. If someone could share an example Snakemake scheduling plan, it might be useful to compare.

The drawback of this approach is that it doesn't execute the entire pipeline, it only goes as far as the cache can take it. On the other hand, stub run can execute the entire pipeline but does not correspond to a real pipeline run.

@bentsherman bentsherman reopened this Aug 24, 2023
@stale stale bot removed stale labels Aug 24, 2023
@bentsherman
Copy link
Member

See also my comments here: #1458 (comment)

@KristinaGagalova
Copy link

I am new in the Nextflow community but I would really love to have this option. I am using it all the time with Snakemake

@subwaystation
Copy link

+1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.