Add extra_args to modules meta-schema.json #7783
Conversation
| @@ -34,6 +34,19 @@ | |||
| "type": "string" | |||
| } | |||
| }, | |||
| "extra_args": { | |||
| "type": "array", | |||
There was a problem hiding this comment.
The current implementation in tools that I used was an object/map:
extra_args:
args:
description: 'samtools index'I found this reduced the duplication/nesting of the fields and felt more intuitive to write.
There was a problem hiding this comment.
oh ok, I missed that. But maybe we should make it an array, to be consistent with the other sections: tools, input, output.
There was a problem hiding this comment.
I would be pro consistency, I don't think it makes a huge amount of difference.
To copy @mirpedrol 's example on slack:
for a map we would write
extra_args:
args:
description: 'samtools index'
a list would be
extra_args:
- args:
description: 'samtools index'
Given the rest of the meta.yaml is using teh - bullet notation then I should already be able to intuite it I think.
There was a problem hiding this comment.
I agree with @awgymer that a key-val pair would be easier to use, but a list is more consistent with the rest of the tools. I'd prefer consistency here, so would go with an array.
| @@ -34,6 +34,19 @@ | |||
| "type": "string" | |||
| } | |||
| }, | |||
| "extra_args": { | |||
| "type": "array", | |||
There was a problem hiding this comment.
I would be pro consistency, I don't think it makes a huge amount of difference.
To copy @mirpedrol 's example on slack:
for a map we would write
extra_args:
args:
description: 'samtools index'
a list would be
extra_args:
- args:
description: 'samtools index'
Given the rest of the meta.yaml is using teh - bullet notation then I should already be able to intuite it I think.
Close tools issue nf-core/tools#3444
Required for tools PR nf-core/tools#3451
Related to website PR nf-core/website#3041