Repository navigation
Nextflow De Novo Transcriptome Characterization Workflow
Engine:
Nextflow· Workflow ID:de_novo_transcriptome_characterization· Path in repo:nextflow/workflows/de_novo_transcriptome_characterization/
This workflow reconstructs and characterises a transcriptome for an organism that has no reference genome, starting from raw RNA-Seq reads. It assembles the reads de novo, removes redundancy from the assembly, measures how complete the result is, predicts the protein-coding regions it contains, and finally assigns biological meaning to those predicted proteins. Functional characterisation combines three independent lines of evidence — sequence homology against a curated protein database, protein signature detection, and orthology-based transfer — reconciled into a single annotation set. The pipeline orchestrates the OmicsBox read-QC, preprocessing, de novo assembly, clustering, completeness assessment, ORF prediction and BLAST2GO annotation analyses end to end.
flowchart TD
%% ---- Inputs ----
IN1[/"Sequencing reads<br/>FASTQ"/]:::input
IN2[/"Trimmomatic<br/>adapter FASTA"/]:::input
IN3[/"FastQC adapter<br/>FASTA"/]:::input
IN4[/"FastQC contaminant<br/>FASTA"/]:::input
%% ---- Processes, declared in execution order ----
P01["FASTQC_RAW"]:::chart
P02["TRIMMOMATIC"]:::omicsbox
P03["FASTQC_POST"]:::chart
P04["TRINITY"]:::omicsbox
P05["CDHIT"]:::omicsbox
P06["BUSCO"]:::omicsbox
P07["TRANSDECODER"]:::omicsbox
P08["LOAD_FASTA"]:::omicsbox
P09["DIAMOND_BLAST"]:::omicsbox
P09C["BLAST_CHARTS"]:::chart
P10["INTERPROSCAN"]:::omicsbox
P10C["IPS_CHARTS"]:::chart
P11["EGGNOG_MAPPER"]:::omicsbox
P12["COMBINE_PROJECTS"]:::omicsbox
P13["MERGE_EGGNOG_5_GOS"]:::omicsbox
%% ---- Data flow ----
IN1 --> P01
IN1 --> P02
IN2 -.-> P02
IN3 -.-> P01
IN3 -.-> P03
IN4 -.-> P01
IN4 -.-> P03
P02 --> P03
P02 --> P04
P04 --> P05
P04 --> P07
P05 --> P06
P05 --> P07
P07 --> P08
P07 --> P11
P08 --> P09
P08 --> P10
P09 --> P09C
P09 --> P12
P10 --> P10C
P10 --> P12
P12 --> P13
P11 --> P13
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 — Profiles the quality of the untrimmed reads with
omicsbox fastqc, optionally screening them against user-supplied adapter and contaminant sequences. It is a diagnostic endpoint: its report is published for inspection and is not consumed by any later step. -
TRIMMOMATIC — Preprocesses the raw reads with
omicsbox trimmomatic, applying the adapter removal, edge-trimming, quality-trimming and read-filtering stages enabled in the configuration. Emits the trimmed reads consumed byFASTQC_POSTandTRINITY, together with a trimming report. -
FASTQC_POST — Re-runs
omicsbox fastqcon the trimmed reads so the effect of preprocessing can be compared against the raw profile. LikeFASTQC_RAW, its report is an endpoint and feeds nothing downstream. -
TRINITY — Assembles the trimmed reads into transcripts with
omicsbox trinity, following the configured strandedness, normalisation and assembly-stage settings. Emits the assembled transcripts consumed byCDHITand the gene-to-transcript mapping consumed byTRANSDECODER. -
CDHIT — Collapses the assembly into a non-redundant set with
omicsbox cdhit, clustering transcripts according to the configured sequence-identity threshold and alignment-coverage criteria. Emits the representative sequences consumed byBUSCOandTRANSDECODER, plus a report and a clustering chart. -
BUSCO — Assesses how complete the clustered assembly is with
omicsbox busco, scoring it against the configured lineage dataset in the configured assessment mode. It is an evaluation endpoint: the project, report and chart it emits are published but not consumed downstream. -
TRANSDECODER — Predicts protein-coding regions in the clustered transcripts with
omicsbox transdecoder, using the gene-to-transcript mapping fromTRINITYto group isoforms of the same gene. Emits the predicted proteins consumed byLOAD_FASTAandEGGNOG_MAPPER, along with the predicted coding sequences and the ORF coordinates. -
LOAD_FASTA — Imports the predicted proteins into a new OmicsBox sequence project via
omicsbox load-sequences, applying the duplicate-ID and header-description policies set in the configuration. Emits the sequence project consumed by bothDIAMOND_BLASTandINTERPROSCAN. -
DIAMOND_BLAST — Runs a DIAMOND homology search against the configured protein database with
omicsbox diamond, in the configured BLAST mode and sensitivity. Emits the project carrying the hit tables, consumed byBLAST_CHARTSandCOMBINE_PROJECTS.-
BLAST_CHARTS — Generates the BLAST statistics charts enabled in the configuration with
omicsbox statistics-blast.
-
BLAST_CHARTS — Generates the BLAST statistics charts enabled in the configuration with
-
INTERPROSCAN — Scans the loaded 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 byIPS_CHARTSandCOMBINE_PROJECTS, together with the raw InterProScan results in the configured export formats.-
IPS_CHARTS — Generates the InterPro statistics charts enabled in the configuration with
omicsbox statistics-interpro.
-
IPS_CHARTS — Generates the InterPro statistics charts enabled in the configuration with
-
EGGNOG_MAPPER — Annotates the predicted proteins by orthology with
omicsbox eggnog-mapper, reading the sequences directly and bypassing the OmicsBox project entirely. Emits an annotation project and a run report; the annotation project is not consumed untilMERGE_EGGNOG_5_GOS. -
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. Emits the combined project consumed byMERGE_EGGNOG_5_GOS. -
MERGE_EGGNOG_5_GOS — Folds the EggNOG-Mapper orthology annotations into the combined project
with
omicsbox merge-emapper5-annotations, subject to the configured alignment filters. Emits the final project holding the three-evidence functional annotation, plus a merge-results chart.
The workflow needs one set of sequencing reads and nothing else. Setting both read parameters, or neither, aborts the run before any OmicsBox job is launched. The three remaining file inputs are optional and are only consulted by the quality-control and trimming steps; every other setting is a value rather than a file and is documented inline in the configuration file.
| Parameter | Format | Required | Description |
|---|---|---|---|
input_single_end / input_paired_end
|
FASTQ (.fastq / .fq / .fastq.gz / .fq.gz) |
✅ | Glob matching the read files of every sample 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. |
trimmomatic.adapters |
FASTA (.fasta / .fa / .faa / .fsa / .ffn / .fnn / .fna / .txt) |
⬜ | Custom adapter sequences handed to TRIMMOMATIC. Trimming against them applies only when the step's adapter-removal flags are enabled in the configuration. |
fastqc.adapters |
FASTA (.fasta / .fsa / .fa / .fna / .fas) |
⬜ | Custom adapter sequences screened for by FASTQC_RAW and FASTQC_POST. Supplying the file enables adapter screening in those steps. |
fastqc.contaminants |
FASTA (.fasta / .fsa / .fa / .fna / .fas) |
⬜ | Custom contaminant sequences screened for by FASTQC_RAW and FASTQC_POST. Supplying the file enables contaminant screening in those steps. |
Note
Two settings are worth checking before the first run. BUSCO needs a lineage dataset matching the
organism's clade — the --lineage entry in its configuration block is commented out by default, so
set it rather than relying on a default. And with single-end input the paired-end-only adapter flags
in the TRIMMOMATIC block (palindrome clipping, minimum adapter length, keeping both reads) must
stay disabled; OmicsBox rejects the run if they are set. The configuration file marks each 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/de_novo_transcriptome_characterization/de_novo_transcriptome_characterization.nf --dump_configThis copies the self-documenting template to ./de_novo_transcriptome_characterization.config in your current directory and exits. No OmicsBox job is launched.
Step 2 — Customise it
Open the generated de_novo_transcriptome_characterization.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/de_novo_transcriptome_characterization/de_novo_transcriptome_characterization.nf \
-c de_novo_transcriptome_characterization.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/de_novo_transcriptome_characterization/de_novo_transcriptome_characterization.nf \
--dump_configThe template is written to your current directory exactly as in Option A.
Step 2 — Customise it
Edit the generated de_novo_transcriptome_characterization.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/de_novo_transcriptome_characterization/de_novo_transcriptome_characterization.nf \
-c de_novo_transcriptome_characterization.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 of the raw reads
├── 02_trimmomatic/ # Trimmed reads and the trimming report
├── 03_fastqc_post/ # Quality-control report of the trimmed reads
├── 04_trinity/ # De novo assembly, gene-to-transcript map and assembly report
├── 05_cdhit/ # Non-redundant representative sequences, report and clustering chart
├── 06_busco/ # Assembly completeness project, report and chart
├── 07_transdecoder/ # Predicted proteins, coding sequences, ORF coordinates and report
├── 08_load_fasta/ # Sequence project loaded from the predicted proteins
├── 09_diamond_blast/ # Project with the DIAMOND BLAST hits
├── 09_blast_charts/ # BLAST statistics charts
├── 10_interproscan/ # Project with the InterPro signatures, plus the raw exports
├── 10_ips_charts/ # InterPro statistics charts
├── 11_eggnog_mapper/ # EggNOG orthology annotations and the run report
├── 12_combine_projects/ # DIAMOND project merged with InterProScan
└── 13_merge_eggnog/ # Final project with the three-evidence functional annotation
-
Nextflow
-
Snakemake