modules icon indicating copy to clipboard operation
modules copied to clipboard

Input naming conventions

Open edmundmiller opened this issue 2 years ago • 4 comments

Follow up to https://github.com/nf-core/modules/pull/1437#discussion_r834774713

We currently use reads for unaligned reads(fastq), and then bam for the aligned reads, but this doesn't cover cram, and sam.

It also doesn't cover things like when a bam or a bed file are possible.

I personally think input is a little too vague to name the variable as well.

edmundmiller avatar Mar 25 '22 13:03 edmundmiller

as mentioned in the other PR I like

aligned_input or input_aligned for bam/cram/sam and then aligned_index for bai/crai/sai

FriederikeHanssen avatar Mar 25 '22 13:03 FriederikeHanssen

as usual @FriederikeHanssen is right on point

maxulysse avatar Mar 25 '22 14:03 maxulysse

For modules that download a database, a naming convention would be great.

I've seen download, update, and setupdb. But I also understand some of these might actually be the names of the subcommand to download the database (e.g. amrfinder_update)

rpetit3 avatar Mar 31 '22 17:03 rpetit3

I don't know what effect #1338 might have on this, but it might solve some of it.

edmundmiller avatar Apr 01 '22 13:04 edmundmiller