modules icon indicating copy to clipboard operation
modules copied to clipboard

Decide on proper naming convention for subworkflows

Open maxulysse opened this issue 1 year ago • 2 comments

maxulysse avatar Oct 06 '22 13:10 maxulysse

Here are some notes from the team brainstorming

Naming convention : 'input_filetype_operation_ToolNames' Ex : bam_sort_samtools Everything is in lowercase

Input filetype File type of the initial input file Ex : fastq, bam, vcf, etc

Operation The operation should describe as best as possible the sub-workflow task. An ontology will be done to make sure we use the same operation name. Ex : align for alignment or mapping

Tool name Include the names of all the tools that are used in the subworkflow If several tools are used in the subworkflow, the tool name(s) should be ordered as used in the subworkflow and separated by underscores. If the tool is used several times in the subworkflow, the tool name should be included only once in the naming of the subworrkflow. If the tool includes options, do not include the option name (i.e. if I use ‘samtools index’ and ‘samtools sort’, I only include ‘samtools’ once in the subworkflow name)

scorreard avatar Oct 10 '22 14:10 scorreard

Should the input file name be limited to only one file format? For now, yes.

For example :
bam_somatic_variant_calling_gatk or bam_cram_somatic_variant_calling_gatk

scorreard avatar Oct 10 '22 14:10 scorreard