nextflow.config

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

// Global default params, used in configs
params {

    // Input parameters
    input = null
    mode = "fastq"
    miairr="$projectDir/assets/reveal/mapping_MiAIRR_BioSample_v1.3.1.tsv"
    index_file = false
    pipelines_testdata_base_path = 'https://raw.githubusercontent.com/nf-core/test-datasets/airrflow/'

    // ----------------------------
    // sequencing protocol options
    // ----------------------------
    library_generation_method = null
    race_linker = null

    // Primer and UMI inputs
    cprimers = null
    vprimers = null
    vprimer_start = 0
    cprimer_start = 0
    cprimer_position = 'R1'
    primer_revpr = false

    // UMI and primer handling
    umi_position = 'R1'
    umi_length = -1
    umi_start = 0

    // trimming options
    trim_fastq = true
    adapter_fasta = null
    clip_r1 = 0
    clip_r2 = 0
    three_prime_clip_r1 = 0
    three_prime_clip_r2 = 0
    trim_nextseq = false
    save_trimmed = false

    // --------------------------
    // sequence assembly options
    // --------------------------
    // Filter sequences
    filterseq_q = 20

    // Mask primers

    primer_r1_maxerror = 0.2
    primer_r2_maxerror = 0.2
    primer_mask_mode = 'cut'
    maskprimers_align = false
    primer_extract_len = 0
    primer_maxlen = 50

    // Build consensus
    primer_consensus = 0.6
    buildconsensus_maxerror = 0.1
    buildconsensus_maxgap = 0.5
    cluster_sets = true

    // Assemble pairs
    assemblepairs_sequential = false

    // internal cregion
    align_cregion = false
    internal_cregion_sequences = null
    cregion_maxlen = 100
    cregion_maxerror = 0.3
    cregion_mask_mode = 'tag'

    // -----------------------
    // vdj annotation options
    // -----------------------
    productive_only = true
    reassign = true
    reference_igblast = "${params.pipelines_testdata_base_path}database-cache/igblast_base.zip"
    reference_fasta = "${params.pipelines_testdata_base_path}database-cache/imgtdb_base.zip"
    fetch_imgt = false
    save_databases = true
    isotype_column = 'c_call'

    // -----------------------
    // bulk filtering options
    // -----------------------
    remove_chimeric = false
    detect_contamination = false
    collapseby = 'sample_id'

    // -----------------------
    // clonal analysis options
    // -----------------------
    cloneby = 'subject_id'
    crossby = 'subject_id'
    singlecell = 'single_cell'
    clonal_threshold = 'auto'
    skip_all_clones_report = false
    skip_report_threshold = false

    // tree lineage options
    lineage_tree_builder = 'raxml'
    lineage_tree_exec = '/usr/local/bin/raxml-ng'
    lineage_trees = false

    // -----------------------
    // reporting options
    // -----------------------
    skip_report = false
    report_rmd = "$projectDir/assets/repertoire_comparison.Rmd"
    report_css = "$projectDir/assets/nf-core_style.css"
    report_logo = "$projectDir/assets/nf-core-airrflow_logo_light.png"
    report_logo_img = "$projectDir/assets/nf-core-airrflow_logo_reports.png"

    // -----------------------
    // Single cell raw input options
    // -----------------------
    reference_10x = null


    // -----------------------
    // generic nf-core options
    // -----------------------

    // References
    igenomes_base              = 's3://ngi-igenomes/igenomes'
    igenomes_ignore            = true

    // MultiQC options
    skip_multiqc               = false
    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

}

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

// Load nf-core custom profiles from different Institutions
try {
    includeConfig "${params.custom_config_base}/nfcore_custom.config"
} catch (Exception e) {
    System.err.println("WARNING: Could not load nf-core/config profiles: ${params.custom_config_base}/nfcore_custom.config")
}

// Load nf-core/airrflow custom profiles from different institutions.
try {
    includeConfig "${params.custom_config_base}/pipeline/airrflow.config"
} catch (Exception e) {
    System.err.println("WARNING: Could not load nf-core/config/airrflow profiles: ${params.custom_config_base}/pipeline/airrflow.config")
}
profiles {
    debug {
        dumpHashes              = true
        process.beforeScript    = 'echo $HOSTNAME'
        cleanup                 = false
        nextflow.enable.configProcessNamesValidation = true
    }
    conda {
        conda.enabled           = true
        docker.enabled          = false
        singularity.enabled     = false
        podman.enabled          = false
        shifter.enabled         = false
        charliecloud.enabled    = false
        conda.channels          = ['conda-forge', 'bioconda', 'defaults']
        apptainer.enabled       = false
    }
    mamba {
        conda.enabled           = true
        conda.useMamba          = true
        docker.enabled          = false
        singularity.enabled     = false
        podman.enabled          = false
        shifter.enabled         = false
        charliecloud.enabled    = false
        apptainer.enabled       = false
    }
    docker {
        docker.enabled          = true
        conda.enabled           = false
        singularity.enabled     = false
        podman.enabled          = false
        shifter.enabled         = false
        charliecloud.enabled    = false
        apptainer.enabled       = false
        docker.runOptions       = '-u $(id -u):$(id -g)'
    }
    arm {
        docker.runOptions       = '-u $(id -u):$(id -g) --platform=linux/amd64'
    }
    singularity {
        conda.enabled = false
        singularity.enabled = true
        singularity.autoMounts = true
        conda.enabled          = false
        docker.enabled         = false
        podman.enabled         = false
        shifter.enabled        = false
        charliecloud.enabled   = false
        apptainer.enabled      = false
    }
    podman {
        podman.enabled          = true
        conda.enabled           = false
        docker.enabled          = false
        singularity.enabled     = false
        shifter.enabled         = false
        charliecloud.enabled    = false
        apptainer.enabled       = false
    }
    shifter {
        shifter.enabled         = true
        conda.enabled           = false
        docker.enabled          = false
        singularity.enabled     = false
        podman.enabled          = false
        charliecloud.enabled    = false
        apptainer.enabled       = false
    }
    charliecloud {
        conda.enabled = false
        charliecloud.enabled   = true
        conda.enabled          = false
        docker.enabled         = false
        singularity.enabled    = false
        podman.enabled         = false
        shifter.enabled        = false
        apptainer.enabled      = false
    }
    apptainer {
        apptainer.enabled       = true
        apptainer.autoMounts    = true
        conda.enabled           = false
        docker.enabled          = false
        singularity.enabled     = false
        podman.enabled          = false
        shifter.enabled         = false
        charliecloud.enabled    = false
    }
    wave {
        apptainer.ociAutoPull   = true
        singularity.ociAutoPull = true
        wave.enabled            = true
        wave.freeze             = true
        wave.strategy           = 'conda,container'
    }
    gitpod {
        executor.name           = 'local'
        executor.cpus           = 4
        executor.memory         = 8.GB
    }
    test      { includeConfig 'conf/test.config'      }
    test_full { includeConfig 'conf/test_full.config' }
    test_tcr { includeConfig 'conf/test_tcr.config' }
    test_no_umi { includeConfig 'conf/test_no_umi.config' }
    test_assembled_hs { includeConfig 'conf/test_assembled_hs.config' }
    test_assembled_mm { includeConfig 'conf/test_assembled_mm.config' }
    test_raw_immcantation_devel { includeConfig 'conf/test_raw_immcantation_devel.config' }
    test_assembled_immcantation_devel_hs { includeConfig 'conf/test_assembled_immcantation_devel_hs.config' }
    test_assembled_immcantation_devel_mm { includeConfig 'conf/test_assembled_immcantation_devel_mm.config' }
    test_nocluster { includeConfig 'conf/test_nocluster.config' }
    test_fetchimgt { includeConfig 'conf/test_fetchimgt.config' }
    test_10x_sc { includeConfig 'conf/test_10x_sc.config' }
    test_clontech_umi { includeConfig 'conf/test_clontech_umi.config' }
    test_nebnext_umi { includeConfig 'conf/test_nebnext_umi.config' }
    nebnext_umi_tcr { includeConfig 'conf/nebnext_umi_tcr.config' }
    nebnext_umi_bcr { includeConfig 'conf/nebnext_umi_bcr.config' }
    clontech_umi_bcr { includeConfig 'conf/clontech_umi_bcr.config' }
    clontech_umi_tcr { includeConfig 'conf/clontech_umi_tcr.config' }
}

// 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'

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

// 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"
    R_LIBS_SITE = "NULL"
    R_LIBS_USER = "NULL"
    JULIA_DEPOT_PATH = "/usr/local/share/julia"
}

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

// Disable process selector warnings by default. Use debug profile to enable warnings.
nextflow.enable.configProcessNamesValidation = false

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/airrflow'
    author          = """Gisela Gabernet, Susanna Marquez, Alexander Peltzer, Simon Heumos"""
    homePage        = 'https://github.com/nf-core/airrflow'
    description     = """B and T cell repertoire analysis pipeline with the Immcantation framework."""
    mainScript      = 'main.nf'
    nextflowVersion = '!>=23.04.0'
    version         = '4.1.0'
    doi             = '10.5281/zenodo.2642009'
}

// 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
        }
    }
}