Repository navigation
Nextflow Eukaryotic Genome Analysis Workflow
Engine:
Nextflow· Workflow ID:eukaryotic_genome_analysis· Path in repo:nextflow/workflows/eukaryotic_genome_analysis/
This workflow reconstructs and characterises a eukaryotic genome from raw short-read DNA-Seq data: starting from sequencing reads alone, with no reference assembly to align against, it produces a draft genome, the protein-coding genes predicted on it, and the biological function of those genes. It assumes Illumina-style short reads of a eukaryotic organism, single-end or paired-end, and covers the whole chain in one run — read quality control and preprocessing, de novo assembly, assembly evaluation against a reference, repeat masking, evidence-aware or ab initio gene finding, and functional annotation of the predicted proteins. The pipeline orchestrates the OmicsBox genome analysis and BLAST2GO annotation suites, from FastQC and Trimmomatic through ABySS, QUAST, BUSCO, RepeatMasker and AUGUSTUS, to DIAMOND BLAST, InterProScan, GO mapping and annotation, and the final InterPro-to-annotation merge.
flowchart TD
%% ---- Inputs ----
IN1[/"Short reads FASTQ"/]:::input
IN2[/"Adapter and<br/>contaminant FASTA"/]:::input
IN3[/"ABySS auxiliary<br/>libraries"/]:::input
IN4[/"Reference genome"/]:::input
IN5[/"Repeat database"/]:::input
IN6[/"Gene finding hints"/]:::input
%% ---- Processes, declared in execution order ----
P01["FASTQC_RAW"]:::chart
P02["TRIMMOMATIC"]:::omicsbox
P03["FASTQC_POST"]:::chart
P04["ABYSS"]:::omicsbox
P05["QUAST"]:::chart
P06["BUSCO"]:::chart
P07["REPEATMASKER"]:::omicsbox
P08["AUGUSTUS"]:::omicsbox
P09["DIAMOND_BLAST"]:::omicsbox
P10["INTERPROSCAN"]:::omicsbox
P11["COMBINE_PROJECTS"]:::omicsbox
P12["GO_MAPPING"]:::omicsbox
P13["GO_ANNOTATION"]:::omicsbox
P14["MERGE_IPS_GOS_<br/>TO_ANNOTATION"]:::omicsbox
%% ---- Data flow ----
IN1 --> P01
IN1 --> P02
IN2 -.-> P01
IN2 -.-> P02
IN2 -.-> P03
IN3 -.-> P04
IN4 --> P05
IN5 -.-> P07
IN6 -.-> P08
P02 --> P03
P02 --> P04
P04 --> P05
P04 --> P06
P04 --> P07
P07 --> P08
P08 --> P09
P08 --> P10
P09 --> P11
P10 --> P11
P11 --> P12 --> P13 --> P14
classDef input fill:#e8f4fd,stroke:#1f77b4,stroke-width:1px;
classDef omicsbox fill:#fff3e0,stroke:#e67e22,stroke-width:1px;
classDef chart fill:#f4ecf7,stroke:#8e44ad,stroke-width:1px;
-
FASTQC_RAW — Assesses the quality of the untrimmed reads with
omicsbox fastqc, screening them against the user-supplied adapter and contaminant lists when those files are provided. Its report is terminal — no later step consumes it — and serves as the baseline the post-trimming run is compared against. -
TRIMMOMATIC — Preprocesses the reads with
omicsbox trimmomatic, applying the adapter removal, edge trimming, quality trimming and quality/length filtering stages enabled in the configuration. For paired-end input it pairs mates by the configured upstream and downstream filename patterns. Emits the trimmed reads consumed byFASTQC_POSTandABYSS, along with a trimming report and, for paired-end runs, the reads whose mate did not survive filtering.-
FASTQC_POST — Re-runs
omicsbox fastqcon the trimmed reads, so the effect of the preprocessing can be read against the raw baseline before the assembly is attempted.
-
FASTQC_POST — Re-runs
-
ABYSS — Assembles the trimmed reads de novo with
omicsbox abyss, building a de Bruijn graph at the configured k-mer size and, when supplied, incorporating the auxiliary libraries as additional assembly and scaffolding evidence. Emits the scaffolded assembly consumed byQUAST,BUSCOandREPEATMASKER, together with the intermediate contig and unitig sequences, the assembly graphs if the configuration asks for them, and an assembly report and chart.-
QUAST — Evaluates the assembly against the supplied reference genome with
omicsbox quast, reporting contiguity, alignment and misassembly metrics under the configured genome type and length, identity and misassembly thresholds. Its results are terminal. -
BUSCO — Scores the assembly for gene-content completeness with
omicsbox busco, against the lineage profile and assessment mode set in the configuration. Its results are terminal.
-
QUAST — Evaluates the assembly against the supplied reference genome with
-
REPEATMASKER — Locates and masks interspersed and low-complexity repeats with
omicsbox repeatmasker, using the configured search engine, repeat database and masking type. Emits the masked genome consumed byAUGUSTUS, plus the repeat annotations, a run report and a repeat-type distribution chart. -
AUGUSTUS — Predicts protein-coding genes on the masked assembly with
omicsbox genefinding-eukaryotic, running either ab initio or from the extrinsic evidence hint files, according to the configured gene finding mode, species model and gene model. Emits the predicted-protein project consumed by bothDIAMOND_BLASTandINTERPROSCAN, together with the predicted CDS and the gene structures, a report and a length-distribution chart. -
DIAMOND_BLAST — Searches the predicted proteins for homologues with
omicsbox diamond, against the protein database, sensitivity level, taxonomy filter and hit thresholds set in the configuration. Emits the project carrying the hit tables, consumed byCOMBINE_PROJECTSand used later as the evidence for GO mapping. -
INTERPROSCAN — Scans the same predicted proteins against the InterPro member databases
selected in the configuration with
omicsbox ips, adding protein families, domains, sites and repeats. Emits the annotated project consumed byCOMBINE_PROJECTS, together with the raw InterProScan results in the configured export formats. -
COMBINE_PROJECTS — Merges the DIAMOND-searched project and the InterProScan project into a
single project with
omicsbox combine-projects, following the per-data-type merge policies and the priority project set in the configuration. Hands the unified project toGO_MAPPING. -
GO_MAPPING — Retrieves the candidate GO terms associated with every BLAST hit from the GOA
database with
omicsbox mapping-cloud, at the database version selected in the configuration. Emits the project with the mapping evidence attached. -
GO_ANNOTATION — Applies the BLAST2GO algorithm through
omicsbox annotation, turning the candidate mappings into a functional annotation according to the configured annotation cut-off, GO weight, BLAST hit filters and per-evidence-code reliability weights. Emits the annotated project. -
MERGE_IPS_GOS_TO_ANNOTATION — Promotes the InterPro-derived GO terms into the functional
annotation with
omicsbox interproscan-join, consolidating both lines of evidence into the final annotated genome project, and emits a merge-results chart alongside it.
A run needs the sequencing reads to assemble and a reference genome for the assembly evaluation. Setting both read parameters, or neither, aborts the run before any OmicsBox job is launched. Every other file input is optional and is read only by the step that consumes it.
| Parameter | Format | Required | Description |
|---|---|---|---|
input_single_end / input_paired_end
|
FASTQ (.fastq / .fq / .fastq.gz / .fq.gz) |
✅ | Glob matching the read files to assemble — set exactly one of the two, whichever matches the library layout. Paired-end mates are paired by filename, so those files must follow one consistent convention, declared through the upstream_pattern and downstream_pattern settings. |
quast.reference_genome |
FASTA (.fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
✅ | Reference genome the draft assembly is compared against by QUAST. Required even though a single step reads it — the run aborts at start-up when it is missing. |
fastqc.adapters |
FASTA (.fasta / .fsa / .fa / .fna / .fas) |
⬜ | Named adapter sequences screened for by FASTQC_RAW and FASTQC_POST, replacing the built-in adapter list. Supplying the file enables adapter screening in those steps. |
fastqc.contaminants |
FASTA (.fasta / .fsa / .fa / .fna / .fas) |
⬜ | Named contaminant sequences the overrepresented-sequence check is screened against, consumed by both FASTQC_RAW and FASTQC_POST, replacing the built-in contaminant list. |
trimmomatic.adapters |
FASTA (.fasta / .fa / .faa / .fsa / .ffn / .fnn / .fna / .txt) |
⬜ | Custom adapter and contaminant sequences to clip in TRIMMOMATIC, used instead of one of the built-in adapter lists and read only when that step is configured to remove adapters. For paired-end palindrome clipping the sequence names have to be matched pairs ending in /1 and /2. |
abyss.linked_reads |
FASTQ (.fastq / .fq / .fastq.gz / .fq.gz) |
⬜ | Linked-read library added to the ABYSS assembly as auxiliary data. |
abyss.additional_pe |
FASTQ / FASTA (.fastq / .fq / .fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
⬜ | Further paired-end libraries added to the ABYSS assembly as auxiliary data. |
abyss.mate_pair |
FASTQ / FASTA (.fastq / .fq / .fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
⬜ | Mate-pair library used by ABYSS for scaffolding. |
abyss.long_sequences |
FASTQ / FASTA (.fastq / .fq / .fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
⬜ | Long sequences, such as assembled RNA-Seq contigs, used by ABYSS to extend scaffolding. |
repeatmasker.database_file |
EMBL (.embl) or FASTA (.fasta / .fsa / .fa / .fna / .fas) |
⬜ | Repeat library consumed by REPEATMASKER. A RepBase database is the EMBL file distributed by GIRI; a custom library is FASTA, and its sequence IDs are best written as >repeatname#class/subclass. Required when that step is configured to run the RMBlast search engine against a RepBase or custom database — the workflow stops at start-up if that combination is selected and the file is missing — and unused by the combinations that ship their own library. |
augustus.est_hints |
FASTA (.fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
⬜ | EST / cDNA evidence passed to AUGUSTUS as gene finding hints. |
augustus.protein_hints |
FASTA (.fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
⬜ | Protein evidence passed to AUGUSTUS as gene finding hints. |
augustus.isoseq_hints |
FASTA (.fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
⬜ | IsoSeq evidence passed to AUGUSTUS as gene finding hints. |
augustus.rna_seq_upstream_hints |
FASTQ / FASTA (.fastq / .fq / .fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
⬜ | RNA-Seq evidence passed to AUGUSTUS as gene finding hints: either a single-end library, or the upstream mate of a paired-end one. |
augustus.rna_seq_downstream_hints |
FASTQ / FASTA (.fastq / .fq / .fasta / .fsa / .fa / .fna / .fas, plain or .gz) |
⬜ | Downstream mate of a paired-end RNA-Seq library, passed to AUGUSTUS as gene finding hints alongside its upstream mate in augustus.rna_seq_upstream_hints. Paired-end RNA-Seq fills both parameters, one mate each; single-end RNA-Seq leaves this one empty. |
Note
Five input conditions are validated before any OmicsBox job is launched, and each one stops the run immediately with an explanatory message:
- Exactly one of
input_paired_endandinput_single_endmust be set — neither both nor neither. -
quast.reference_genomemust be set, becauseQUASTpasses the reference toomicsbox quastunconditionally. -
repeatmasker.database_filemust be present when the configured search engine and database type require an external repeat library. - At least one hint file must be provided when
AUGUSTUSis configured to run in extrinsic evidence mode; ab initio mode needs none. Only one file per evidence type is supported. -
augustus.rna_seq_downstream_hintsmust be accompanied byaugustus.rna_seq_upstream_hints, since a downstream mate is only meaningful as one half of a paired-end library.
The read layout also constrains the step flags: several TRIMMOMATIC options apply to paired-end
input only and make OmicsBox fail if they are enabled for a single-end run. The configuration file
marks every one of them inline.
This workflow follows the repository's self-documenting configuration strategy: you do not need to memorise parameter names, consult a reference table, or learn the OmicsBox CLI syntax. Every customisable option is already declared, grouped, and documented with inline comments inside the workflow's own configuration file.
To configure a run:
- Generate your own copy of the configuration file — Step 1 of Execution below.
- Open it in any text editor and read the inline comments; each option lists its accepted values and its default.
- Fill in the values you need and comment / uncomment the flags you want to enable or disable.
- Leave everything else untouched — the entries you do not change fall back to the tested defaults.
Tip
Keep your customised configuration file next to your project data and under version control. It is a complete, human-readable record of how a run was parameterised, which is all you need to reproduce it later.
Before running this workflow for the first time, complete the environment setup described on the central Nextflow Execution & Configuration page.
Two ways to run this workflow are supported. Option A is recommended when you want to inspect or modify the pipeline code; Option B runs the published version straight from GitHub with no manual clone.
Assuming you have already cloned the repository and navigated to its root directory:
Step 1 — Dump the configuration file
nextflow run nextflow/workflows/eukaryotic_genome_analysis/eukaryotic_genome_analysis.nf --dump_configThis copies the self-documenting template to ./eukaryotic_genome_analysis.config in your current directory and exits. No OmicsBox job is launched.
Step 2 — Customise it
Open the generated eukaryotic_genome_analysis.config and edit it as described in Configuration: set your input paths and output folder, then fill in or comment/uncomment the step-specific flags you want to change. Save the file.
Step 3 — Run the workflow
nextflow run nextflow/workflows/eukaryotic_genome_analysis/eukaryotic_genome_analysis.nf \
-c eukaryotic_genome_analysis.config \
-resumeNo clone required — the engine fetches the workflow for you.
Step 1 — Dump the configuration file
nextflow run BioBam/omicsbox-engine-workflows \
-r main \
-main-script nextflow/workflows/eukaryotic_genome_analysis/eukaryotic_genome_analysis.nf \
--dump_configThe template is written to your current directory exactly as in Option A.
Step 2 — Customise it
Edit the generated eukaryotic_genome_analysis.config exactly as in Option A — see Configuration. Since the pipeline code lives remotely, this file is the only thing you own and edit.
Step 3 — Run the workflow
nextflow run BioBam/omicsbox-engine-workflows \
-r main \
-main-script nextflow/workflows/eukaryotic_genome_analysis/eukaryotic_genome_analysis.nf \
-c eukaryotic_genome_analysis.config \
-resumeAll results are written under the output directory set in your configuration file (local_folder), inside a subfolder named after the Nextflow session ID of the run. Each step publishes to its own numbered directory, so every file can be traced back to the process that produced it:
results/
└── <session-id>/
├── 01_fastqc_raw/ # Quality control report and charts of the raw reads
├── 02_trimmomatic/ # Trimmed reads and the trimming report
├── 03_fastqc_post/ # Quality control report and charts of the trimmed reads
├── 04_abyss/ # Draft assembly sequences with the assembly report and chart
├── 05_quast/ # Assembly quality assessment results, report and charts
├── 06_busco/ # Assembly completeness assessment project, report and charts
├── 07_repeatmasker/ # Masked genome, repeat annotations, report and chart
├── 08_augustus/ # Predicted proteins, CDS and gene structures with the report and chart
├── 09_diamond_blast/ # Project with the DIAMOND BLAST hits
├── 10_interproscan/ # Project with the InterPro signatures, plus the raw exports
├── 11_combine_projects/ # DIAMOND project merged with InterProScan
├── 12_go_mapping/ # Project with the candidate GO mappings
├── 13_go_annotation/ # BLAST2GO-annotated project
└── 14_merge_ips/ # InterPro GO terms merged into the final annotation
-
Nextflow
-
Snakemake