Arnaud Boré
01/26/2025, 7:13 PMparams used in the module for our users in the meta.yml . They have to dig into the main.nf. Can we add information about these params into the meta.yml ?
2. I know we can define default value for those parameters directly into the main.nf. It would make more sense in my opinion to have default values stored directly into a nextflow.config attached to the module. Then, it would make these default value available for both main.nf and the meta.yml to get these values printed when running "nf-core module info my_awsome_module" for example.
I feel like these questions are really specific to the development of a library, I know there are a lot of things done as a pipeline perspective but here it's a little bit different.
Thank you in advance 🙂
@Florian Wuennemann, @Anthony Gagnon Follow up on our discussion 🙂Phil Ewels
01/26/2025, 7:24 PMPhil Ewels
01/26/2025, 7:24 PMAnthony Gagnon
01/27/2025, 2:36 AMArthur
01/27/2025, 3:41 AMSimon Pearce
01/27/2025, 10:11 AMPhil Ewels
01/27/2025, 10:20 AMPhil Ewels
01/27/2025, 10:21 AMAnthony Gagnon
01/27/2025, 1:00 PMArnaud Boré
01/28/2025, 9:24 PMAlex Valcourt Caron
01/31/2025, 3:04 PMPhil Ewels
01/31/2025, 7:23 PMAlex Valcourt Caron
02/03/2025, 2:14 PMparams scope, because of the mess and potential collisions it'll create. nf-core and nextflow don't want us to use task.ext, because it is not really meant for it.Alex Valcourt Caron
02/03/2025, 2:15 PMtask.ext. It was about 2 years ago and still is today. It does all heavy lifting maintenance wise. Our users get used to them quite easily. The only problem we have had with it is documentation, but we found a way. We render it on a website and uses a new field in meta.yml. This could easily be added to nf-core commands and help users to have a full understanding of each module.Arnaud Boré
02/03/2025, 3:28 PMBen Sherman
02/03/2025, 3:46 PMparams global
I think the answer is record types. You bundle a bunch of related params into a record, pass the record around, and pass whatever record members you need into the process
For this reason I haven't pushed the params issue very much (keeping it as a "paranoid" warning for now) until the language supports record typesArnaud Boré
02/03/2025, 3:50 PMparams in meta.yml
• Make sure nf-core module info can list these params
• Make sure it can be lintedSimon Pearce
02/03/2025, 3:59 PMArnaud Boré
02/03/2025, 4:01 PMAlex Valcourt Caron
02/03/2025, 4:56 PMAlex Valcourt Caron
02/03/2025, 4:58 PMSimon Pearce
02/03/2025, 5:25 PMSimon Pearce
02/03/2025, 5:26 PMArthur
02/03/2025, 8:55 PMval(tool_params) and if more val(tool2_params).
To me the bigger issue is how you capture generic user-supplied params. ext.args is horrible because it can't easily be additive.
At one stage I wanted to use nested params namespaced for the tool e.g. --minimap2.kmer_size 3 but I believe that there are reasons to avoid nested params.
One possibly over-engineered option is to define tool params in your top-level params as a json/yml input file which you parse into a validated map of allowed options using nf-schema.Ben Sherman
02/04/2025, 2:04 PMrecord SraParams {
ena_metadata_fields : String
download_method : DownloadMethod
skip_fastq_download : boolean
dbgap_key : Path?
}
There is also some discussion here about how to improve on the ext args.
Just keep in mind that there are a lot of other ideas in that PR that aren't related here. But I do welcome all feedback in the PR comments 😄Arnaud Boré
02/04/2025, 3:45 PMparams in meta.yml
• Make sure nf-core module info can list these params
• Make sure it can be linted
Thank you in advance 🙂Phil Ewels
02/04/2025, 4:19 PMPhil Ewels
02/04/2025, 4:19 PM