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

[create] Improve logic in CLI wizard #2341

Open
2 tasks
Tracked by #2340
ewels opened this issue Jun 27, 2023 · 1 comment · May be fixed by nf-core/website#2742
Open
2 tasks
Tracked by #2340

[create] Improve logic in CLI wizard #2341

ewels opened this issue Jun 27, 2023 · 1 comment · May be fixed by nf-core/website#2742
Labels
command line tools Anything to do with the cli interfaces
Milestone

Comments

@ewels
Copy link
Member

ewels commented Jun 27, 2023

At the moment, the wizard in nf-core create is not very user friendly.

  • Needs a lot more help text
  • Needs simpler distinction between usage for nf-core or not
    • Should be one of the first questions. Point out that it's difficult to go back to being nf-core.
  • When customising for non nf-core, features should be opt-in, not opt-out
  • Better phrasing of questions - focus on usage, not feature names
    • Current bad example: "Remove igenomes"
    • Could be rephrased:
      "Will this pipeline work with genomics data?
      (Does it need built-in configuration for reference genome indices?)"
  • Add more options about certain behaviour, such as installing default modules

I was too afraid to not include something we might need so i simply clicked N when I was asked 😄
@FloWuenne

  • Sketch out potential flow and discuss (in this issue)
  • Refactor prompts
@ewels ewels added the command line tools Anything to do with the cli interfaces label Jun 27, 2023
@awgymer
Copy link
Contributor

awgymer commented Jun 27, 2023

As part of this might be useful to properly maintain docs on what fields a template.yml can have and what values they can take.
Currently you can't tell particularly easily and you are better off running the wizard to generate one first.

Very minor as running the wizard isn't really that intensive, but it is interactive and some use case where you want to programatically run create with a --template-yaml does exist. Also, and this is really quite niche, if you want to update the template of your repo to include/exclude a particular optional feature then technically you can do so by adjusting the template.yaml appropriately and running nf-core sync with the modified file passed to --template-yaml. Again it would be useful to be able to edit/construct that more easily without needing to run a create command to generate it for you.

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
3 participants