https://nf-co.re logo
Join Slack
Powered by
I have a question regarding parameter naming. The ...
# nostupidquestions
a
I have a question regarding parameter naming. The nf-core guidelines states that
Boolean parameters default to 
false
(prefer 
skip_step = false
over 
run_step = true
)
(https://nf-co.re/docs/checklists/reviews/pipeline_release_pr#parameter-conventions) However, sometimes one might want to mirror some tool's parameters, which may default to true. What is better in this case? Renaming the parameters or having them default to true?
m
for me, it depends
I then to have skip_ for things that I think should run by default, and run_ for things that should not run by default
like skip_ for multiqc, it can totally be optional but for me it should run by default. run_ is more when I want my user to actively choose something
a
Yeah, my question was more about forwarding tools parameters to the pipeline level
m
I'd say it's more a UX design question than simply naming convention
and to be honest, until recently, I have been not super happy with the way we deal with that
but then #C06PHJM0Y3D happened
😄 1
and with this, I am finally happy
it's clear in the workflow as every tool follow the same logic: https://github.com/nf-core/seqinspector/blob/dev/workflows/seqinspector.nf
either a 
'my_tools' in tools
in a if or in a filter
a
Right, basically I just wanted to know how strict this guideline was, I guess my question is answered then 😄
😆 1
m
For me as long as it's a guideline and not a rule you know my answer
And even if it's a rule...
😆 2
s
shared a GIF
❤️ 1
2 Views
Open in Slack
PreviousNext
Powered by