org.broadinstitute.hellbender.utils.wdlTemplates.wdlToolTemplate.wdl.ftl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gatk Show documentation
Development on GATK 4
The newest version!
version 1.0

<#--- Store positional args in a WDL arg called "positionalArgs"--->
<#assign positionalArgs="--positionalArgs"/>
<#if beta?? && beta == true>
# Run ${name} (**BETA**) (WDL auto generated from GATK Version ${version})
<#elseif experimental?? && experimental == true>
# Run ${name} **EXPERIMENTAL** ${name} (WDL auto generated from GATK Version ${version})
<#else>
# Run ${name} (WDL auto generated from GATK Version ${version})

#
# ${summary}
#
#  General Workflow (non-tool) Arguments
#    ${"dockerImage"?right_pad(50)} Docker image for this workflow
#    ${"gatk"?right_pad(50)} Location of gatk to run for this workflow
#    ${"memoryRequirements"?right_pad(50)} Runtime memory requirements for this workflow
#    ${"diskRequirements"?right_pad(50)} Runtime disk requirements for this workflow
#    ${"cpuRequirements"?right_pad(50)} Runtime CPU count for this workflow
#    ${"preemptibleRequirements"?right_pad(50)} Runtime preemptible count for this workflow
#    ${"bootdisksizegbRequirements"?right_pad(50)} Runtime boot disk size for this workflow
#
<#if arguments.positional?size != 0>
<@addArgumentDescriptions heading="Positional Tool Arguments" argsToUse=arguments.positional/>
#

<#if arguments.required?size != 0>
<@addArgumentDescriptions heading="Required Tool Arguments" argsToUse=arguments.required/>
#


workflow ${name} {

  input {
    #Docker to use
    String dockerImage
    #App location
    String gatk
    #Memory to use
    String memoryRequirements
    #Disk requirements for this workflow
    String diskRequirements
    #CPU requirements for this workflow
    String cpuRequirements
    #Preemptible requirements for this workflow
    String preemptibleRequirements
    #Boot disk size requirements for this workflow
    String bootdisksizegbRequirements
    <@defineWorkflowInputs heading="Positional Arguments" argsToUse=arguments.positional/>
    <@defineWorkflowInputs heading="Required Arguments" argsToUse=arguments.required/>

  }

  call ${name} {

    input:

        #Docker
        ${"dockerImage"?right_pad(50)} = dockerImage,
        #App location
        ${"gatk"?right_pad(50)} = gatk,
        #Memory to use
        ${"memoryRequirements"?right_pad(50)} = memoryRequirements,
        #Disk requirements for this workflow
        ${"diskRequirements"?right_pad(50)} = diskRequirements,
        #CPU requirements for this workflow
        ${"cpuRequirements"?right_pad(50)} = cpuRequirements,
        #Preemptible requirements for this workflow
        ${"preemptibleRequirements"?right_pad(50)} = preemptibleRequirements,
        #Boot disk size requirements for this workflow
        ${"bootdisksizegbRequirements"?right_pad(50)} = bootdisksizegbRequirements,

        <@callTaskInputs heading="Positional Arguments" argsToUse=arguments.positional/>
        <@callTaskInputs heading="Required Arguments" argsToUse=arguments.required/>

  }

  output {
    <@defineWorkflowOutputs heading="Workflow Outputs" outputs=runtimeOutputs/>
  }

  parameter_meta {
    dockerImage: { description: "Docker image for this task" }
    gatk: { description: "Location of gatk to run for this task" }
    memoryRequirements: { description: "Runtime memory requirements for this task" }
    diskRequirements: { description: "Runtime disk requirements for this task" }
    cpuRequirements: { description: "Runtime CPU count for this task" }
    preemptibleRequirements: { description: "Runtime preemptible count for this task" }
    bootdisksizegbRequirements: { description: "Runtime boot disk size for this task" }
    <@defineParamMeta heading="Positional Arguments" argsToUse=arguments.positional/>
    <@defineParamMeta heading="Required Arguments" argsToUse=arguments.required/>
  }
}

task ${name} {

  input {
    String dockerImage
    String gatk
    String memoryRequirements
    String diskRequirements
    String cpuRequirements
    String preemptibleRequirements
    String bootdisksizegbRequirements
    <@defineTaskInputs heading="Positional Arguments" argsToUse=arguments.positional/>
    <@defineTaskInputs heading="Required Arguments" argsToUse=arguments.required/>

  }

  command <<<
    ~{gatk} ${name} \
        <@callTaskCommand heading="Positional Arguments" argsToUse=arguments.positional/>
        <@callTaskCommand heading="Required Arguments" argsToUse=arguments.required/>

  >>>

  <#if workflowProperties?? && workflowProperties?size != 0>
  runtime {
      docker: dockerImage
      memory: memoryRequirements
      disks: diskRequirements
      cpu: cpuRequirements
      preemptible: preemptibleRequirements
      bootDiskSizeGb: bootdisksizegbRequirements
  }
  

  output {
    <@defineTaskOutputs heading="Task Outputs" outputs=runtimeOutputs/>
  }

  parameter_meta {
    dockerImage: { description: "Docker image for this task" }
    gatk: { description: "Location of gatk to run for this task" }
    memoryRequirements: { description: "Runtime memory requirements for this task" }
    diskRequirements: { description: "Runtime disk requirements for this task" }
    cpuRequirements: { description: "Runtime CPU count for this task" }
    preemptibleRequirements: { description: "Runtime preemptible count for this task" }
    bootdisksizegbRequirements: { description: "Runtime boot disk size for this task" }
    <@defineParamMeta heading="Positional Arguments" argsToUse=arguments.positional/>
    <@defineParamMeta heading="Required Arguments" argsToUse=arguments.required/>
  }
}

<#--------------------------------------->
<#-- Macros -->

<#macro addArgumentDescriptions heading argsToUse>
    <#if argsToUse?size != 0>
#  ${heading}
        <#list argsToUse as arg>
            <#if heading?starts_with("Positional")>
#    ${positionalArgs?substring(2)?right_pad(50)} ${arg.summary?right_pad(60)[0..*80]}
                <#if requiredCompanions?? && requiredCompanions[positionalArgs]??>
                    <#list requiredCompanions[positionalArgs] as companion>
#    ${companion.name?substring(2)?right_pad(50)} ${companion.summary?right_pad(60)[0..*80]}
                    
                
                <#if optionalCompanions?? && optionalCompanions[positionalArgs]??>
                    <#list optionalCompanions[positionalArgs] as companion>
#    ${companion.name?substring(2)?right_pad(50)} Optional ${companion.summary?right_pad(60)[0..*80]}
                    
                
            <#else>
#    ${arg.name?substring(2)?right_pad(50)} ${arg.summary?right_pad(60)[0..*80]}
                <#if requiredCompanions?? && requiredCompanions[arg.name]??>
                    <#list requiredCompanions[arg.name] as companion>
#    ${companion.name?substring(2)?right_pad(50)} ${companion.summary?right_pad(60)[0..*80]}
                    
                
                <#if optionalCompanions?? && optionalCompanions[arg.name]??>
                    <#list optionalCompanions[arg.name] as companion>
#    ${companion.name?substring(2)?right_pad(50)} Optional ${companion.summary?right_pad(60)[0..*80]}
                    
                
            
        
    



<#macro defineParamMeta heading argsToUse>
    <#if argsToUse?size != 0>

    # ${heading}
        <#list argsToUse as arg>
            <#if heading?starts_with("Positional")>
                <#if localizationOptional?seq_contains(positionalArgs)>
    ${positionalArgs?substring(2)}<#noparse>: {
      description: "${arg.summary[0..*80]}<#noparse>",
      localization_optional : true <#noparse>
    }
                <#else>
    ${positionalArgs?substring(2)}<#noparse>: { description: "${arg.summary[0..*80]}<#noparse>" }
                
                <#if requiredCompanions?? && requiredCompanions[positionalArgs]??>
                    <#list requiredCompanions[positionalArgs] as companion>
                        <#if localizationOptional?seq_contains(positionalArgs)>
    ${companion.name?substring(2)}<#noparse>: {
      description: "${companion.summary[0..*80]}<#noparse>",
      localization_optional : true <#noparse>
    }
                        <#else>
    ${companion.name?substring(2)}<#noparse>: { description: "${companion.summary[0..*80]}<#noparse>" }
                        
                    
                
                <#if optionalCompanions?? && optionalCompanions[positionalArgs]??>
                    <#list optionalCompanions[positionalArgs] as companion>
                        <#if localizationOptional?seq_contains(positionalArgs)>
    ${companion.name?substring(2)}<#noparse>: {
      description: "${arg.summary[0..*80]}<#noparse>",
      localization_optional : true <#noparse>
    }
                        <#else>
                            ${companion.name?substring(2)}<#noparse>: { description: "${companion.summary(60)[0..*80]}<#noparse>" }
                        
                    
                
            <#else>
                <#if localizationOptional?seq_contains(arg.name)>
    ${arg.name?substring(2)}<#noparse>: {
        description: "${arg.summary[0..*80]}<#noparse>",
        localization_optional : true <#noparse>
    }
                <#else>
    ${arg.name?substring(2)}<#noparse>: { description: "${arg.summary[0..*80]}<#noparse>" }
                
                <#if requiredCompanions?? && requiredCompanions[arg.name]??>
                    <#list requiredCompanions[arg.name] as companion>
                        <#if localizationOptional?seq_contains(companion.name)>
    ${companion.name?substring(2)}<#noparse>: {
      description: "${companion.summary[0..*80]}<#noparse>",
      localization_optional : true <#noparse>
    }
                        <#else>
    ${companion.name?substring(2)}<#noparse>: { description: "${companion.summary[0..*80]}<#noparse>" }
                        
                    
                
                <#if optionalCompanions?? && optionalCompanions[arg.name]??>
                    <#list optionalCompanions[arg.name] as companion>
                        <#if localizationOptional?seq_contains(companion.name)>
    ${companion.name?substring(2)}<#noparse>: {
      description: "${companion.summary[0..*80]}<#noparse>",
      localization_optional : true <#noparse>
    }
                        <#else>
    ${companion.name?substring(2)}<#noparse>: { description: "${companion.summary[0..*80]}<#noparse>" }
                        
                    
                
            
        
    


<#macro defineWorkflowInputs heading argsToUse>
    <#if argsToUse?size != 0>

    # ${heading}
        <#list argsToUse as arg>
            <#if heading?starts_with("Positional")>
    ${arg.wdlinputtype} ${positionalArgs?substring(2)}
                <#if requiredCompanions?? && requiredCompanions[positionalArgs]??>
                    <#list requiredCompanions[positionalArgs] as companion>
    ${arg.wdlinputtype} ${companion.name?substring(2)}
                    
                
                <#if optionalCompanions?? && optionalCompanions[positionalArgs]??>
                    <#list optionalCompanions[positionalArgs] as companion>
    ${arg.wdlinputtype}? ${companion.name?substring(2)}
                    
                
            <#else>
    ${arg.wdlinputtype}<#if !heading?starts_with("Required")>? ${arg.name?substring(2)}
                <#if requiredCompanions?? && requiredCompanions[arg.name]??>
                    <#list requiredCompanions[arg.name] as companion>
    ${arg.wdlinputtype} ${companion.name?substring(2)}
                    
                
                <#if optionalCompanions?? && optionalCompanions[arg.name]??>
                    <#list optionalCompanions[arg.name] as companion>
    ${arg.wdlinputtype}? ${companion.name?substring(2)}
                    
                
            
        
    


<#macro callTaskInputs heading argsToUse>
    <#if argsToUse?size != 0>

        # ${heading}
        <#list argsToUse as arg>
            <#if heading?starts_with("Positional")>
        ${positionalArgs?substring(2)?right_pad(50)} = ${positionalArgs?substring(2)},
                <#if requiredCompanions?? && requiredCompanions[positionalArgs]??>
                    <#list requiredCompanions[positionalArgs] as companion>
        ${companion.name?substring(2)?right_pad(50)} = ${companion.name?substring(2)},
                    
                
                <#if optionalCompanions?? && optionalCompanions[positionalArgs]??>
                    <#list optionalCompanions[positionalArgs] as companion>
        ${companion.name?substring(2)?right_pad(50)} = ${companion.name?substring(2)},
                    
                
            <#else>
        ${arg.name?substring(2)?right_pad(50)} = ${arg.name?substring(2)},
                <#if requiredCompanions?? && requiredCompanions[arg.name]??>
                    <#list requiredCompanions[arg.name] as companion>
        ${companion.name?substring(2)?right_pad(50)} = ${companion.name?substring(2)},
                    
                
                <#if optionalCompanions?? && optionalCompanions[arg.name]??>
                    <#list optionalCompanions[arg.name] as companion>
        ${companion.name?substring(2)?right_pad(50)} = ${companion.name?substring(2)},
                    
                
            
        
    


<#macro defineTaskInputs heading argsToUse>
    <#if argsToUse?size != 0>
        <#list argsToUse as arg>
            <#if heading?starts_with("Positional")>
    ${arg.wdlinputtype} ${positionalArgs?substring(2)}
                <#if requiredCompanions?? && requiredCompanions[arg.name]??>
                    <#list requiredCompanions[positionalArgs] as companion>
    ${arg.wdlinputtype} Positional_${companion.name?substring(2)}
                    
                
                <#if optionalCompanions?? && optionalCompanions[arg.name]??>
                    <#list optionalCompanions[positionalArgs] as companion>
    ${arg.wdlinputtype}? Positional_${companion.name?substring(2)}
                    
                
            <#else>
    ${arg.wdlinputtype}<#if !heading?starts_with("Required")>? ${arg.name?substring(2)}
                <#if requiredCompanions?? && requiredCompanions[arg.name]??>
                    <#list requiredCompanions[arg.name] as companion>
    ${arg.wdlinputtype} ${companion.name?substring(2)}
                    
                
                <#if optionalCompanions?? && optionalCompanions[arg.name]??>
                    <#list optionalCompanions[arg.name] as companion>
    ${arg.wdlinputtype}? ${companion.name?substring(2)}
                    
                
            
        
    


<#macro defineWorkflowOutputs heading outputs>
    # ${heading?right_pad(50)}
    <#if requiredOutputs?size == 0>
    File ${name}results = ${name}.${name}_results
    <#else>
        <#list requiredOutputs?keys as requiredKey>
    ${requiredOutputs[requiredKey]} ${name}${requiredKey?substring(2)} = ${name}.${name}_${requiredKey?substring(2)}
            <#if requiredCompanions?? && requiredCompanions[requiredKey]??>
                <#list requiredCompanions[requiredKey] as companion>
    ${requiredOutputs[requiredKey]} ${name}${companion.name?substring(2)} = ${name}.${name}_${companion.name?substring(2)}
                
            
            <#if optionalCompanions?? && optionalCompanions[requiredKey]??>
                <#list optionalCompanions[requiredKey] as companion>
    ${requiredOutputs[requiredKey]}? ${name}${companion.name?substring(2)} = ${name}.${name}_${companion.name?substring(2)}
                
            
        
    


<#macro defineTaskOutputs heading outputs>
    # ${heading?right_pad(50)}
    <#if requiredOutputs?size == 0>
    File ${name}_results = stdout()
    <#else>
        <#list requiredOutputs?keys as requiredKey>
    ${requiredOutputs[requiredKey]} ${name}_${requiredKey?substring(2)} = ${requiredKey?substring(2)}
            <#if requiredCompanions?? && requiredCompanions[requiredKey]??>
                <#list requiredCompanions[requiredKey] as companion>
    ${requiredOutputs[requiredKey]} ${name}_${companion.name?substring(2)} = ${companion.name?substring(2)}
                
            
            <#if optionalCompanions?? && optionalCompanions[requiredKey]??>
                <#list optionalCompanions[requiredKey] as companion>
    ${requiredOutputs[requiredKey]}? ${name}_${companion.name?substring(2)} = ${companion.name?substring(2)}
                
            
        
    


<#macro callTaskCommand heading argsToUse>
    <#if argsToUse?size != 0>
        <#list argsToUse as arg>
            <#if heading?starts_with("Positional")>
    <#noparse>~{sep=' ' ${positionalArgs?substring(2)}<#noparse>} \
            <#elseif heading?starts_with("Required")>
    ${arg.actualArgName} <#noparse>~{sep=' ${arg.actualArgName} <#noparse>' ${arg.name?substring(2)}<#noparse>} \
            <#else>
    <#noparse>~{true='${arg.actualArgName} <#noparse>' false='' defined(${arg.name?substring(2)}<#noparse>)}~{sep=' ${arg.actualArgName} <#noparse>' ${arg.name?substring(2)}<#noparse>} \