nextflow.config

/*
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    nf-core/dragenflow Nextflow config file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    Default config options for all compute environments
----------------------------------------------------------------------------------------
*/

// Global default params, used in configs
params {

    // workflow parameter. This sets the analysis mode.
    // It is set with the analysis profiles (see below).
    workflow                    = null

    // Can add aribitrary arguments, if needed.
    extra_dragen_args           = null

    // inputs
    input                       = null
    outdir                      = null
    target_bedfile              = null    
    data_path                   = null
    mgi                         = false
    
    tracedir                    = "${params.outdir}/pipeline_info"

    user_group                  = "compute-dspencer"
    queue                       = "dspencer"
    job_group_name              = "/dspencer/nextflow"

    // Extra Dragen options
    alignment_file_format      = 'CRAM'
    mark_duplicates            = true
    pangenome_reference        = false
    variant_caller             = false
    sv_caller                  = false
    cnv_caller                 = false
    use_nirvana                = false
    umi                        = null
    readfamilysize             = 3
    solid_tumor                = false
    liquid_tumor               = false
    downsample_rna             = null
    dux4caller                 = false
    dragen_cnv_filter_length   = null //500000
    dragen_cnv_merge_distance  = null //2000000
    sv_annotation_distance     = null //20000
    max_filter_sv_length       = null //150000000

    // DRAGEN alignment options
    intermediate_dir                  = "/staging/intermediate-results-dir"
    refdir                            = "/storage2/fs1/dspencer/Active/spencerlab/refdata/hg38/dragen_hg38v4.3.6"
    dbsnp                             = "/storage2/fs1/dspencer/Active/spencerlab/refdata/hg38/dragenfiles/dbsnp.vcf.gz"
    methylation_refdir                = null
    adapter1                          = "${projectDir}/assets/data/dragen_adapter1.fa"
    adapter2                          = "${projectDir}/assets/data/dragen_adapter2.fa"
    annotation_gtf                    = null
    transcript_table                  = null
    cnv_population_vcf                = null
    snv_noisefile                     = null
    sv_noisefile                      = null
    hotspot_vcf                       = null
    hotspot_bed                       = null
    dragen_tandem_dup_hotspots        = null
    
    // References
    fasta                             = "/storage2/fs1/dspencer/Active/spencerlab/refdata/hg38/sequence/hg38_mgi_patch.fa"
    cram_reference                    = "/storage2/fs1/dspencer/Active/spencerlab/refdata/hg38/sequence/hg38_mgi_patch.fa"
    
    // VEP and Nirvana annotation dirs
    vepcache                          = "/storage2/fs1/dspencer/Active/spencerlab/refdata/hg38/VEP113_cache"
    nirvana_path                      = "/storage2/fs1/dspencer/Active/spencerlab/refdata/hg38/dragenfiles/nirvana_annotation_data_323"
    nirvana_assembly                  = "GRCh38"

    // cytobansd
    cytobands                         = "${projectDir}/assets/data/hg38.cytoBandIdeo.bed.gz"

    local_dragen_container            = "apldx/oracle8-dragen-4.3.6"
    aws_dragen_container              = "job-definition://dragen_v4-4-6"

    // for testing
    run_dragen = true

    // TODO nf-core: Specify your pipeline's command line flags
    // Input options
    // References
    genome                     = null
    igenomes_base              = 's3://ngi-igenomes/igenomes'
    igenomes_ignore            = true
    
    // MultiQC options
    multiqc_config             = null
    multiqc_title              = null
    multiqc_logo               = null
    max_multiqc_email_size     = '25.MB'
    multiqc_methods_description = null

    // Boilerplate options
    outdir                     = null
    publish_dir_mode           = 'copy'
    email                      = null
    email_on_fail              = null
    plaintext_email            = false
    monochrome_logs            = false
    hook_url                   = null
    help                       = false
    version                    = false

    // Config options
    config_profile_name        = null
    config_profile_description = null
    custom_config_version      = 'master'
    custom_config_base         = "https://raw.githubusercontent.com/nf-core/configs/${params.custom_config_version}"
    config_profile_contact     = null
    config_profile_url         = null
    

    // Max resource options
    // Defaults only, expecting to be overwritten
    max_memory                 = '128.GB'
    max_cpus                   = 16
    max_time                   = '240.h'

    // Schema validation default options
    validationFailUnrecognisedParams = false
    validationLenientMode            = false
    validationSchemaIgnoreParams     = 'genomes,igenomes_base'
    validationShowHiddenParams       = false
    validate_params                  = true

}

// Nextflow plugins
plugins {
    id 'nf-validation@1.1.3' // Validation of pipeline parameters and creation of an input channel from a sample sheet
    id 'nf-amazon'
}

aws {
    region                        = 'us-east-1'
    accessKey                     = secrets.AWS_ACCESS_KEY
    secretKey                     = secrets.AWS_SECRET_KEY
}

// Load base.config by default for all pipelines
includeConfig 'conf/base.config'

profiles {
    
    // Dragen analysis profiles
    alignonly      { includeConfig 'conf/alignonly.config' }
    germline       { includeConfig 'conf/germline.config' }
    somaticheme    { includeConfig 'conf/somaticheme.config' }
    somaticsolid   { includeConfig 'conf/somaticsolid.config' }
    tumoronlyheme  { includeConfig 'conf/tumoronlyheme.config' }
    tumoronlysolid { includeConfig 'conf/tumoronlysolid.config' }
    idtumi         { includeConfig 'conf/idtumi.config' }
    rnaseq         { includeConfig 'conf/rnaseq.config' }

    test { includeConfig 'conf/test.config' } // this run demux on first tile only
    stub { includeConfig 'conf/stub.config' } // local executor for testing
    
    ris {
        executor.queueSize        = 20
        executor.submitRateLimit  = '1/1sec'
        process {
            executor                  = "lsf"
            clusterOptions            =   { "-a 'docker(${task.container})' -q ${params.queue} -G ${params.user_group} -g ${params.job_group_name}" }
        }
    }
    
    dragen2 {
        process {
            withLabel: 'dragen' {
                ext.dragen_container = "${params.local_dragen_container}"
                ext.dragen_path = "/opt/dragen/4.3.6"
                queue = { "dragen-2" }
                memory  = 200.GB
                cpus = 20
                time = 16.h
                clusterOptions = { "-a 'gtac-mgi-dragen(${task.container})' -m compute1-dragen-2 -G ${params.user_group} -g ${params.job_group_name} -env 'all, LSF_DOCKER_DRAGEN=y'" }
            }
        }
    }

    dragen4 {
        process {
            withLabel: 'dragen' {
                ext.dragen_container = "${params.local_dragen_container}"            
                ext.dragen_path = "/opt/dragen/4.3.6"
                queue = { "dragen-4" }
                memory  = 300.GB
                cpus = 30
                time = 16.h                
                clusterOptions = { "-a 'gtac-mgi-dragen(${task.container})' -m compute1-dragen-4 -G ${params.user_group} -g ${params.job_group_name} -env 'all, LSF_DOCKER_DRAGEN=y'" }
            }
        }
    }

    aws {
        wave.enabled   = true
        fusion.enabled = true
        process {
            executor             = 'awsbatch'
            queue                = 'nextflow-aws-queue'
        }
        params.refdir = "/storage2/fs1/dspencer/Active/spencerlab/refdata/hg38/dragen_hg38_cg_rna_cnv_v4.4.6/"
        params.extra_dragen_args = "--validate-pangenome-reference false" // for dragen 4.4.6
        bucketDir = "s3://dhslab-dragen-data"
        process {
            withLabel: 'dragen' {
                executor                = 'awsbatch'
                ext.dragen_container = "${params.aws_dragen_container}"
                ext.dragen_path         = "/opt/edico"
                ext.dragen_license_args = "--lic-server 'https://${secrets.AWS_DRAGEN_USER}:${secrets.AWS_DRAGEN_PASSWORD}@license.edicogenome.com'"
                queue                   = 'dragen-queue_v4-4-6'
                containerOptions        = '--privileged --ulimit nofile=65535:65535 --ulimit nproc=16384:16384'
                maxErrors               = 1
                cpus                    = 24
                memory                  = 240.GB
                time                    = 24.h
            }
        }
    }

    dragenaws {
        params.refdir = "/storage2/fs1/dspencer/Active/spencerlab/refdata/hg38/dragen_hg38_cg_rna_cnv_v4.4.6/"
        bucketDir = "s3://dhslab-dragen-data"
        process {
            withLabel: 'dragen' {
                executor                = 'awsbatch'
                ext.dragen_container = "${params.aws_dragen_container}"
                ext.dragen_path         = "/opt/edico"
                ext.dragen_license_args = "--lic-server 'https://${secrets.AWS_DRAGEN_USER}:${secrets.AWS_DRAGEN_PASSWORD}@license.edicogenome.com'"
                queue                   = 'dragen-queue_v4-4-6'
                containerOptions        = '--privileged --ulimit nofile=65535:65535 --ulimit nproc=16384:16384'
                maxErrors               = 1
                cpus                    = 24
                memory                  = 240.GB
                time                    = 24.h
            }
        }
    }
}

// Set default registry for Apptainer, Docker, Podman and Singularity independent of -profile
// Will not be used unless Apptainer / Docker / Podman / Singularity are enabled
// Set to your registry if you have a mirror of containers
apptainer.registry   = 'quay.io'
docker.registry      = 'quay.io'
podman.registry      = 'quay.io'
singularity.registry = 'quay.io'

// Load igenomes.config if required
if (!params.igenomes_ignore) {
    includeConfig 'conf/igenomes.config'
} else {
    params.genomes = [:]
}
// Export these variables to prevent local Python/R libraries from conflicting with those in the container
// The JULIA depot path has been adjusted to a fixed path `/usr/local/share/julia` that needs to be used for packages in the container.
// See https://apeltzer.github.io/post/03-julia-lang-nextflow/ for details on that. Once we have a common agreement on where to keep Julia packages, this is adjustable.

env {
    PYTHONNOUSERSITE = 1
    R_PROFILE_USER   = "/.Rprofile"
    R_ENVIRON_USER   = "/.Renviron"
    JULIA_DEPOT_PATH = "/usr/local/share/julia"
}

// Capture exit codes from upstream processes when piping
process.shell = ['/bin/bash', '-euo', 'pipefail']

def trace_timestamp = new java.util.Date().format( 'yyyy-MM-dd_HH-mm-ss')
timeline {
    enabled = true
    file    = "${params.outdir}/pipeline_info/execution_timeline_${trace_timestamp}.html"
}
report {
    enabled = true
    file    = "${params.outdir}/pipeline_info/execution_report_${trace_timestamp}.html"
}
trace {
    enabled = true
    file    = "${params.outdir}/pipeline_info/execution_trace_${trace_timestamp}.txt"
}
dag {
    enabled = true
    file    = "${params.outdir}/pipeline_info/pipeline_dag_${trace_timestamp}.html"
}

manifest {
    name            = 'nf-core/dragenflow'
    author          = """Nidhi"""
    homePage        = 'https://github.com/nf-core/dragenflow'
    description     = """Run multple dragen workflows (5mc,rna,tumor_normal)"""
    mainScript      = 'main.nf'
    nextflowVersion = '!>=23.04.0'
    version         = '1.0dev'
    doi             = ''
}

// Load modules.config for DSL2 module specific options
includeConfig 'conf/modules.config'

// Function to ensure that resource requirements don't go beyond
// a maximum limit
def check_max(obj, type) {
    if (type == 'memory') {
        try {
            if (obj.compareTo(params.max_memory as nextflow.util.MemoryUnit) == 1)
                return params.max_memory as nextflow.util.MemoryUnit
            else
                return obj
        } catch (all) {
            println "   ### ERROR ###   Max memory '${params.max_memory}' is not valid! Using default value: $obj"
            return obj
        }
    } else if (type == 'time') {
        try {
            if (obj.compareTo(params.max_time as nextflow.util.Duration) == 1)
                return params.max_time as nextflow.util.Duration
            else
                return obj
        } catch (all) {
            println "   ### ERROR ###   Max time '${params.max_time}' is not valid! Using default value: $obj"
            return obj
        }
    } else if (type == 'cpus') {
        try {
            return Math.min( obj, params.max_cpus as int )
        } catch (all) {
            println "   ### ERROR ###   Max cpus '${params.max_cpus}' is not valid! Using default value: $obj"
            return obj
        }
    }
}