template.nextflow.config

/*
================================================================================================
                                    Config File TransPi
================================================================================================
                            Transcriptome Analysis Pipeline
                            Author: Ramón E. Rivera-Vicéns
                            GitHub: rivera10
----------------------------------------------------------------------------------------
*/

params {

    // -------------------------  EDIT below variables (mandatory)  ------------------------- //
    // --------------------- Can also be specified in the command line ---------------------- //

        // Modify this accordingly (if needed)
        // kmers list (depends on read length!)
            k=""

        // SOAP config file generator
            //#maximal read length
                maxReadLen=""
            //[LIB]
            //#maximal read length in this lib
                rd_len_cutof="${params.maxReadLen}"

            // Other options if needed. Leave defaults if unsure.
            //#average insert size
            //avg_ins="200"
            //#if sequence needs to be reversed
                reverse_seq="0"
            //#in which part(s) the reads are used
                asm_flags="3"
            //#minimum aligned length to contigs for a reliable read location (at least 32 for short insert size)
                map_len="32"

    // --------------------------  EDIT below variables if needed  -------------------------- //

    // Directory for results
        outdir="results"

    // Directory for trace files
        tracedir="pipeline_info"

    // PATH for rnammer, tmhmm, signalp programs. Requires licenses. See CBS-DTU tools for information.
        // RNAmmer
            rnam = ""
        // Tmhmm
            tmhmm = ""
        // SignalP
            signalp = ""

    /*
    // ------------------------------------------------     STOP     ------------------------------------------------ //

        Most of these values below are filled by the precheck script (e.g. PATH to databases or conda installation).
        However, if you run the precheck for a container you will not have all these PATHs assigned (e.g. conda PATH).
        Run the precehck again but selecting conda instead of containers if that is the case.


        For other options (e.g. filtering, buscoDist, etc.) is recommended to call them from the command line.


        Proceed to the end of this config file to modify the processes CPUs and RAM with the specs of your system.
        Also to modify the profiles if you use a scheduler manager like SLURM or PBS.


        More info at the TransPi repository (https://github.com/PalMuc/TransPi) and
        manual (https://palmuc.github.io/TransPi/).


    // -------------------------------------------------------------------------------------------------------------- //
    */

    // PATH to TransPi DBs installation
        pipeInstall

    // PATH to conda installation from precheck. Leave blank is precheck was not used or you will use containers
        myCondaInstall=""

    //busco4 conda env
        cenv=""

    // Uniprot database PATH
        uniprot
        uniname

    //BUSCO database
        busco4db

    //PFAM file location
        pfloc

    //name of pfam file
        pfname

    //Trinotate sqlite created when installing Trinotate
        Tsql

    // Directory for reads
        reads=""

    // Pipeline options
        help = false
        fullHelp = false

    // Full analysis
        all = false

    // Only Evidential Gene run (one sample per run)
        onlyEvi = false

    // Only annotation analysis
        onlyAnn = false

    // Only Assemblies and Evidential Gene
        onlyAsm = false

    // Skip quality control
        skipQC = false

    // Skip fastp quality filter step
        skipFilter = false
    // Minimum reads quality for filtering in fastp
        minQual="25"

    // Filter rRNA
        rRNAfilter = false
        // rRNA database
        rRNAdb = ""

    // Skip normalization of reads
        skipNormalization = false
        // Normalization parameters
        normMaxCov=100
        normMinCov=1

    // Save reads from filtering and normalization
        saveReads = false

    // Save bam file from mapping step
        saveBam = false

    // Filter Species using psytrans
        filterSpecies = false
    // Psytrans value to train model
        psyval=160
    // Host Sequence
        host=""
    // Symbiont Sequence
        symbiont=""

    // Run BUSCO in all assemblies
        allBuscos = false

    // BUSCO distribution analysis (this option needs to be run together with the allBuscos option)
        // Generate the analysis
        buscoDist = false
        // Mininmum percentage of assemblers require to rescue a BUSCO sequence
        minPerc="0.7"

    //short Transdecoder, no homlogy search PFAM and UniProt
        shortTransdecoder = false

    // Annotation options
    // SignalP
        withSignalP = false
    // tmHMM
        withTMHMM = false
    // rnammer
        withRnammer = false
    // Add annotation to file
        addAnnotation = false

    //Test data
        readsTest = false

    // Skip Evidential Gene for onlyAsm option
        skipEvi = false

    // Skip Kegg pathway search
        skipKegg = false

    // Skip Report
        skipReport = false

    // These options will change how the profiles work.
        // Run with conda installed by the precheck
            myConda = false
            condaActivate = false

        // TransPi container with all programs
            oneContainer = false

        // Cache directory for conda and singularity files. Leave in blank if not sure
            envCacheDir = ""

        // Singularity
        // Use singularity image created after pulling from docker and not from Galaxy depot (singularity image ready to use).
            singularity_pull_docker_container = false

    // Get software versions - only works with local conda installation and TransPi container.
        skipGetRunInfo = false
}

/*
// ------------------------------------------------     NOTE     ------------------------------------------------ //


    Proceed to modify the processes CPUs and RAM with the specs of your system.
    Also to modify the profiles if you use a scheduler manager like SLURM or PBS.


    More info at the TransPi repository (https://github.com/PalMuc/TransPi) and
    manual (https://palmuc.github.io/TransPi/).

    Also see Nextflow documentation (https://www.nextflow.io/docs/latest/index.html).


// -------------------------------------------------------------------------------------------------------------- //
*/

process {
    cpus='1'
    memory='5 GB'
    withLabel: big_cpus {
        cpus='20'
        memory='15 GB'
    }
    withLabel: med_cpus {
        cpus='8'
        memory='15 GB'
    }
    withLabel: low_cpus {
        cpus='4'
        memory='15 GB'
    }
    withLabel: exlow_cpus {
        cpus='1'
        memory='2 GB'
    }
    withLabel: big_mem {
        cpus='20'
        memory='350 GB'
    }
    withLabel: med_mem {
        cpus='15'
        memory={ 100.Gb + (task.attempt * 50.Gb)}
        errorStrategy={ task.exitStatus in 137..140 ? 'retry' : 'finish' }
        maxRetries = 2
    }
    withLabel: low_mem {
        cpus='20'
        memory='80 GB'
    }
    errorStrategy='finish'
}

// env Evidential Gene variable (only for nextflow)
env.evi="${projectDir}/scripts/evigene"

// Temp BUSCO V4 container for oneContainer option.
params.v4container="ezlabgva/busco:v4.0.5_cv1"

// Get PATH for cache environments
params.localCacheDir = (params.envCacheDir ? "${params.envCacheDir}" : "${launchDir}")

profiles {
    conda {
        params.condaActivate = true
        params.localConda="${params.myCondaInstall}"
        // cache for condaEnv created individually
        conda.cacheDir = "${params.localCacheDir}/condaEnv/"
    }
    docker {
        docker.enabled = true
        docker.runOptions = "-u \$(id -u):\$(id -g) -v ${params.pipeInstall}:${params.pipeInstall}"
        // --mount type=bind,src=${params.pipeInstall},dst=/dockerDB"
    }
    singularity {
        singularity.enabled = true
        singularity.autoMounts = true
        // cache for images from docker pull
        singularity.cacheDir="${params.localCacheDir}/singularityCache/"
    }
    test {
        includeConfig 'conf/test.config'
    }
    TransPiContainer {
        process {
            params.oneContainer = true
            params.TPcontainer="rerv/transpi:v1.0.0"
        }
    }
    palmuc {
        process {
            executor='slurm'
            clusterOptions='-p lemmium --qos=low'
        }
    }
}

executor {
  $slurm {
    queueSize=100
  }
}

timeline {
  enabled = true
  file = "${params.outdir}/${params.tracedir}/transpi_timeline.html"
}
report {
  enabled = true
  file = "${params.outdir}/${params.tracedir}/transpi_report.html"
}
trace {
  enabled = true
  file = "${params.outdir}/${params.tracedir}/transpi_trace.txt"
}
dag {
  enabled = true
  file = "${params.outdir}/${params.tracedir}/transpi_dag.html"
}

manifest {
    name = 'TransPi'
    author = 'Ramón E. Rivera-Vicéns'
    description = 'Transcriptome Analysis Pipeline'
    mainScript = 'TransPi.nf'
    nextflowVersion = '>=20.10.0'
    version = '1.1.0-rc'
}