Skip to content

Conversation

@mirpedrol
Copy link
Member

Close tools issue nf-core/tools#3444

Required for tools PR nf-core/tools#3451

Related to website PR nf-core/website#3041

}
},
"extra_args": {
"type": "array",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh ok, I missed that. But maybe we should make it an array, to be consistent with the other sections: tools, input, output.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

}
},
"extra_args": {
"type": "array",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@mirpedrol
Copy link
Member Author

I am going to merge this PR since we have enough votes 👍

@mirpedrol mirpedrol added this pull request to the merge queue Jun 19, 2025
Merged via the queue into nf-core:master with commit a923860 Jun 19, 2025
13 checks passed
@mirpedrol mirpedrol deleted the args-to-yaml branch June 19, 2025 10:29
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 this pull request may close these issues.

4 participants