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

RefGenie - build local Nextflow config #1083

Closed
ewels opened this issue May 18, 2021 · 0 comments · Fixed by #1090
Closed

RefGenie - build local Nextflow config #1083

ewels opened this issue May 18, 2021 · 0 comments · Fixed by #1090
Assignees
Labels
command line tools Anything to do with the cli interfaces

Comments

@ewels
Copy link
Member

ewels commented May 18, 2021

Split from #592 - specifically #592 (comment)


@nsheff managed to add plugin hooks and build an example @nf-core plugin all in a day! Over here: https://github.com/databio/refgenie_nfcore

Can use this to model the RefGenie integration. This will work super nicely because it is so harmless:

  • RefGenie installed, nf-core not installed: Nothing
  • RefGenie not installed, nf-core installed: Nothing
  • RefGenie and nf-core installed: Nextflow genomes config automagically maintained

There will be no action required by users beyond installing two tools that they will be using anyway. 🚀


So basically, add a setuptools entrypoint to nf-core/tools that executes some custom code within RefGenie runs.

Some slight differences / extensions that I think would be nice compared to the repo above:

  • Automatically write to $NXF_HOME/nf-core/genomes.config if path not set otherwise.
  • Prompt to add an includeConfig line to the $NXF_HOME/config file if not already there.
    • This means that we can overwrite the genomes.config safely each time.
  • Alternatively (skipping the includeConfig thing):

Need to be sure that it fails gracefully if RefGenie is not installed.

@ewels ewels added the command line tools Anything to do with the cli interfaces label May 18, 2021
@KevinMenden KevinMenden linked a pull request May 20, 2021 that will close this issue
4 tasks
@ewels ewels assigned ErikDanielsson and mirpedrol and unassigned KevinMenden Jun 17, 2022
@ewels ewels closed this as completed Jul 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
command line tools Anything to do with the cli interfaces
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants