/* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ nf-core/rnaseq Nextflow config file ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Default config options for all compute environments ---------------------------------------------------------------------------------------- */ // Global default params, used in configs params { // Input options input = null // References genome = null splicesites = null gtf_extra_attributes = 'gene_name' gtf_group_features = 'gene_id' skip_gtf_filter = false skip_gtf_transcript_filter = false featurecounts_feature_type = 'exon' featurecounts_group_type = 'gene_biotype' gencode = false prokaryotic = false gffread_transcript_fasta = false save_reference = false igenomes_base = 's3://ngi-igenomes/igenomes/' igenomes_ignore = false arm = false // UMI handling with_umi = false skip_umi_extract = false umitools_extract_method = 'string' umi_dedup_tool = 'umitools' umitools_grouping_method = 'directional' umitools_dedup_stats = false umitools_dedup_primary_only = false umitools_bc_pattern = null umitools_bc_pattern2 = null umitools_umi_separator = null umi_discard_read = 0 save_umi_intermeds = false // Linting skip_linting = false extra_fqlint_args = '--disable-validator P001' // Trimming trimmer = 'trimgalore' min_trimmed_reads = 10000 extra_trimgalore_args = null extra_fastp_args = null save_trimmed = false skip_trimming = false // BBSplit genome filtering bbsplit_fasta_list = null save_bbsplit_reads = false skip_bbsplit = true // Ribosomal RNA removal remove_ribo_rna = false ribo_removal_tool = 'sortmerna' use_gpu_ribodetector = false save_non_ribo_reads = false ribo_database_manifest = "${projectDir}/assets/rrna-db-defaults.txt" bowtie2_rrna_index = null // Alignment aligner = 'star_salmon' use_sentieon_star = false use_parabricks_star = false use_rustqc = false gpu_container_options = null pseudo_aligner = null pseudo_aligner_kmer_size = 31 seq_center = null seq_platform = null bam_csi_index = false star_ignore_sjdbgtf = false salmon_quant_libtype = null hisat2_build_memory = '200.GB' // Amount of memory required to build HISAT2 index with splice sites stringtie_ignore_gtf = false min_mapped_reads = 5 extra_star_align_args = null extra_hisat2_align_args = null extra_bowtie2_align_args = null extra_salmon_index_args = null extra_salmon_quant_args = null extra_kallisto_quant_args = null kallisto_quant_fraglen = 200 kallisto_quant_fraglen_sd = 200 save_merged_fastq = false save_unaligned = false save_align_intermeds = false skip_markduplicates = false skip_alignment = false skip_pseudo_alignment = false skip_quantification_merge = false stranded_threshold = 0.8 unstranded_threshold = 0.1 fail_on_low_trimmed_reads = false fail_on_low_mapped_reads = false fail_on_undetermined_strandedness = false // QC skip_qc = false skip_bigwig = false skip_stringtie = false skip_fastqc = false skip_preseq = true skip_dupradar = false skip_qualimap = false contaminant_screening = null contaminant_screening_input = 'unmapped' kraken_db = null save_kraken_assignments = false save_kraken_unassigned = false bracken_precision = "S" sylph_db = null sylph_taxonomy = null skip_rseqc = false skip_biotype_qc = false skip_deseq2_qc = false skip_multiqc = false deseq2_vst = true rseqc_modules = 'bam_stat,inner_distance,infer_experiment,junction_annotation,junction_saturation,read_distribution,read_duplication' // 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 force_completion_email = false monochrome_logs = false help = false help_full = false show_hidden = false version = false pipelines_testdata_base_path = 'https://raw.githubusercontent.com/nf-core/test-datasets/7f1614baeb0ddf66e60be78c3d9fa55440465ac8/' trace_report_suffix = new java.util.Date().format( 'yyyy-MM-dd_HH-mm-ss') // 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 // Schema validation default options validate_params = true } // Backwards compatibility for publishDir syntax outputDir = params.outdir workflow.output.mode = params.publish_dir_mode // Default publishing logic for pipeline process { // Per-sample output prefix: when skip_quantification_merge is enabled, // per-sample outputs are published under /// // instead of //. Only applies to processes with sample-level // meta (identified by the presence of 'single_end' key, an nf-core // convention). Processes with reference meta or no meta get no prefix. ext.publish_prefix = { (params.skip_quantification_merge && meta?.containsKey('single_end')) ? "${meta.id}/" : "" } publishDir = [ path: { "${params.outdir}/${task.ext.publish_prefix}${task.process.tokenize(':')[-1].tokenize('_')[0].toLowerCase()}" }, mode: params.publish_dir_mode, saveAs: { filename -> filename.equals('versions.yml') ? null : filename } ] } // Load base.config by default for all pipelines includeConfig 'conf/base.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'] 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)' } arm64 { params.arm = true process.arch = 'arm64' includeConfig 'conf/arm.config' } emulate_amd64 { // Run AMD64 containers on ARM hardware using emulation (slower but more compatible) docker.runOptions = '-u $(id -u):$(id -g) --platform=linux/amd64' } singularity { 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 { 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' } test { includeConfig 'conf/test.config' process { resourceLimits = [ cpus: 4, memory: '15.GB', time: '1.h' ] } } test_gpu { includeConfig 'conf/test.config' process { resourceLimits = [ cpus: 8, memory: '30.GB', time: '2.h' ] } } test_full { includeConfig 'conf/test_full.config' } test_prokaryotic { includeConfig 'conf/prokaryotic.config' includeConfig 'conf/test_prokaryotic.config' } prokaryotic { includeConfig 'conf/prokaryotic.config' } rapid_quant { includeConfig 'conf/rapid_quant.config' } test_full_aws { includeConfig 'conf/test_full.config' } test_full_gcp { includeConfig 'conf/test_full.config' params.input = 'https://raw.githubusercontent.com/nf-core/test-datasets/rnaseq/samplesheet/v3.10/samplesheet_full_gcp.csv' } test_full_azure { includeConfig 'conf/test_full.config' params.input = 'https://raw.githubusercontent.com/nf-core/test-datasets/rnaseq/samplesheet/v3.10/samplesheet_full_azure.csv' } } // Load nf-core custom profiles from different institutions // If params.custom_config_base is set AND either the NXF_OFFLINE environment variable is not set or params.custom_config_base is a local path, the nfcore_custom.config file from the specified base path is included. // Load nf-core/rnaseq custom profiles from different institutions. includeConfig params.custom_config_base && (!System.getenv('NXF_OFFLINE') || !params.custom_config_base.startsWith('http')) ? "${params.custom_config_base}/nfcore_custom.config" : "/dev/null" // Load nf-core/rnaseq custom profiles from different institutions. includeConfig params.custom_config_base && (!System.getenv('NXF_OFFLINE') || !params.custom_config_base.startsWith('http')) ? "${params.custom_config_base}/pipeline/rnaseq.config" : "/dev/null" // Set default registry for Apptainer, Docker, Podman, Charliecloud and Singularity independent of -profile // Will not be used unless Apptainer / Docker / Podman / Charliecloud / 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' charliecloud.registry = 'quay.io' // Load igenomes.config if required includeConfig !params.igenomes_ignore ? 'conf/igenomes.config' : 'conf/igenomes_ignored.config' // 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" } // Set bash options process.shell = [ "bash", "-C", // No clobber - prevent output redirection from overwriting files. "-e", // Exit if a tool returns a non-zero status/exit code "-u", // Treat unset variables and parameters as an error "-o", // Returns the status of the last command to exit.. "pipefail" // ..with a non-zero status or zero if all successfully execute ] // Disable process selector warnings by default. Use debug profile to enable warnings. nextflow.enable.configProcessNamesValidation = false timeline { enabled = true file = "${params.outdir}/pipeline_info/execution_timeline_${params.trace_report_suffix}.html" } report { enabled = true file = "${params.outdir}/pipeline_info/execution_report_${params.trace_report_suffix}.html" } trace { enabled = true file = "${params.outdir}/pipeline_info/execution_trace_${params.trace_report_suffix}.txt" } dag { enabled = true file = "${params.outdir}/pipeline_info/pipeline_dag_${params.trace_report_suffix}.html" } manifest { name = 'nf-core/rnaseq' contributors = [ [ name: 'Harshil Patel', affiliation: 'Seqera', github: '@drpatelh', contribution: ['author'], orcid: '0000-0003-2707-7940' ], [ name: 'Jonathan Manning', affiliation: 'Seqera', github: '@pinin4fjords', contribution: ['author', 'maintainer'], orcid: '0000-0002-3483-8456' ], [ name: 'Maxime U Garcia', affiliation: 'Seqera', github: '@maxulysse', contribution: ['contributor', 'maintainer'], orcid: '0000-0003-2827-9261' ], [ name: 'Phil Ewels', affiliation: 'Seqera', github: '@ewels', contribution: ['author'], orcid: '0000-0003-4101-2502' ], [ name: 'Alexander Peltzer', affiliation: 'Boehringer Ingelheim', github: '@apeltzer', contribution: ['contributor'], orcid: '0000-0002-6503-2180' ], [ name: 'Rickard Hammarén', affiliation: 'Scilifelab Data Centre', github: '@Hammarn', contribution: ['author'], orcid: '0000-0001-9017-591X' ], [ name: 'Olga Botvinnik', affiliation: 'Seanome', github: '@olgabot', contribution: ['contributor'], orcid: '0000-0003-4412-7970' ], [ name: 'Adam Talbot', affiliation: 'Seqera', github: '@adamrtalbot', contribution: ['contributor'], ], [ name: 'Friederike Hanssen', affiliation: 'Seqera', github: '@FriederikeHanssen', contribution: ['contributor'], orcid: '0009-0001-9875-5262' ], [ name: 'Robert Syme', affiliation: 'Seqera', github: '@robsyme', contribution: ['contributor'], orcid: '0000-0002-8721-2350' ], ] homePage = 'https://github.com/nf-core/rnaseq' description = """RNA sequencing analysis pipeline for gene/isoform quantification and extensive quality control.""" mainScript = 'main.nf' defaultBranch = 'master' nextflowVersion = '!>=25.10.4' version = '3.28.0' doi = 'https://doi.org/10.5281/zenodo.1400710' diagram = 'docs/images/nf-core-rnaseq_metro_map_animated.svg' } // Nextflow plugins plugins { id 'nf-schema@2.7.3' // Validation of pipeline parameters and creation of an input channel from a sample sheet id 'nf-core-utils@0.7.0' // Shared pipeline initialisation, reporting and software version utilities } validation { defaultIgnoreParams = ["genomes", "igenomes_base"] monochromeLogs = params.monochrome_logs } // Load DSL2 module specific options // prepare reference includeConfig 'conf/modules/prepare_genome.config' // pre-processing includeConfig 'conf/modules/cat_fastq.config' includeConfig 'conf/modules/fastp.config' includeConfig 'conf/modules/trimgalore.config' includeConfig 'conf/modules/qc_trim_filter.config' includeConfig 'conf/modules/strandedness.config' includeConfig 'conf/modules/bbsplit.config' includeConfig 'conf/modules/sortmerna.config' // alignment includeConfig 'conf/modules/align_star.config' includeConfig 'conf/modules/align_bowtie2.config' includeConfig 'conf/modules/align_hisat2.config' includeConfig 'conf/modules/markduplicates.config' // quantification includeConfig './subworkflows/nf-core/quantify_rsem/nextflow.config' includeConfig './subworkflows/nf-core/quantify_pseudo_alignment/nextflow.config' includeConfig './subworkflows/nf-core/quant_tximport_summarizedexperiment/nextflow.config' // QC includeConfig 'conf/modules/featurecounts.config' includeConfig 'conf/modules/multiqc_custom_biotype.config' includeConfig 'conf/modules/stringtie.config' includeConfig 'conf/modules/rseqc.config' includeConfig 'conf/modules/qualimap.config' includeConfig 'conf/modules/dupradar.config' includeConfig 'conf/modules/preseq.config' includeConfig 'conf/modules/rustqc.config' includeConfig 'conf/modules/kraken2.config' includeConfig 'conf/modules/bracken.config' includeConfig 'conf/modules/sylph.config' includeConfig 'conf/modules/sylphtax.config' includeConfig 'conf/modules/multiqc.config' // Pipeline-level process overrides // NOTE: Order matters - later configs take precedence when multiple // withName selectors match the same process. includeConfig 'conf/modules/quantify_bam_salmon.config' includeConfig 'conf/modules/alignment.config' includeConfig 'conf/modules/umi_dedup.config' includeConfig 'conf/modules/bigwig.config' includeConfig 'conf/modules/deseq2_qc.config' includeConfig 'conf/modules/quantify_rsem.config' includeConfig 'conf/modules/quantify_pseudo_alignment.config'