nf-core/isoseq
Genome annotation with PacBio Iso-Seq. Takes raw subreads as input, generate Full Length Non Chemiric (FLNC) sequences and produce a bed annotation.
Version history
[!WARNING] This 3.0.0 major release have breaking changes. Samplesheets and command lines written for v2.0.0 will not work unmodified. See the v3.0.0 changelog notes for details.
Patch release fixing reference genome resolution when --genome is used.
Added
- Added
manifest.diagram, pointing at the pipeline metro map so that it is displayed on the pipeline’s nf-co.re and Seqera Platform pages
Fixed
- Runs using
--genome(or any iGenomes key) failed immediately withMissing genome. A genome to annotate must be provided with the --fasta or --genome option., even though the parameter summary showed the expectedfastaandgtfpaths. The iGenomes attributes were assigned withparams.fasta = getGenomeAttribute('fasta')inmain.nf, which on the Nextflow versions supported by this pipeline (>= 25.10.4) only populates the entry script’s parameters: included subworkflows and workflows still sawparams.fastaas undefined. The reference files are now resolved in the entry workflow, once all config files (including those given with-c) are loaded, and passed down explicitly to theISOSEQworkflow instead of being read fromparams. This also covers a--genomekey defined, or selected, in a custom config given with-c. Explicit--fasta/--gtfvalues still take precedence over the iGenomes ones. This affected thetest_fullprofile and any user run driven by--genome; runs passing--fastadirectly (including thetestprofile) were not affected. - Declared
fastaandgtfas pipeline parameters innextflow.config, removing theWARN: Access to undefined parametermessages emitted at startup
[!WARNING] This is a major release with breaking changes. Samplesheets and command lines written for v2.0.0 will not work unmodified. See the migration notes below.
Added
- New samplesheet-driven input system: each row declares its own entry point via
start_from, allowing subreads, CCS, full-length and long-read FASTA inputs to be mixed in a single run #40, #57 - Support for multiple libraries (cells) per sample, merged with TAMA
- Input chunking before mapping via the new
chunkersubworkflow, controlled bychunk_ccsandchunk_mapping - Added parameter
tama_merge_allto allow merging of sample-wise beds into a single annotation bed - Updated nf-core template to version 4.1.0
Changed
- Breaking: the samplesheet format has been redefined. Columns are now
sample,seq_data,pbi,start_from, replacingsample,bam,pbi,reads. Theseq_datacolumn takes any supported input file, andstart_from(ccs,lima,refineormapping) declares where that row enters the pipeline. TheNoneplaceholder is replaced bynonefor absentpbifiles. - Breaking: the
chunkparameter has been split intochunk_ccsandchunk_mapping, which independently control chunking of CCS generation and of mapping. - Breaking: the minimum Nextflow version is now
25.10.4(was23.04.0). - Breaking: output files are now prefixed with
<sample>_<N>,Nbeing the 0-based row number in the samplesheet, so that several rows can share a sample name. Rows starting fromlima,refineormappingare split before mapping and their files are named<sample>_<N>.chunk.<X>.*. TAMA merge outputs keep the plain sample name. See the output documentation. - Software versions are now collected through Nextflow topic channels instead of a dedicated module.
--primersis no longer unconditionally required. It is only consumed byLIMAandisoseq refine, so it is now required only when at least one samplesheet row usesstart_fromccs,limaorrefine. Runs where every row usesmappingcan omit it #50
Removed
- Breaking: removed the
--entrypointparameter. Per-rowstart_fromin the samplesheet replaces it, and is strictly more flexible: entry points can now differ between samples within one run. - Breaking: removed
--max_cpus,--max_memoryand--max_time. These were replaced by theresourceLimitsdirective in the nf-core template; set limits in a custom config instead. - Removed the
--hook_urlparameter, following the nf-core template. - Removed the
custom/dumpsoftwareversionsmodule.
Fixed
- Updated all nf-core modules to their latest revisions (
bamtools/convert,gnu/sort,gstama/collapse,gstama/merge,gstama/polyacleanup,gunzip,isoseq/refine,lima,minimap2/align,multiqc,pbccs,ultra/align,ultra/index) - Replaced the
utils_nfvalidation_pluginsubworkflow withutils_nfschema_plugin, moving parameter validation tonf-schema2.5.1 - Moved local subworkflows into their own directories to follow nf-core guidelines
- Improved samplesheet validation:
start_fromis now anenum, file-extension patterns are correctly anchored, and a.bam.pbiindex is required whenstart_fromisccs#48 - Fixed
CSS/CCStypo in the documentation #36 - The documented
ccsoptionsmin_passes,min_snr,top_passes,min_lengthandmax_lengthare now actually passed toPBCCS(onlyrqwas before) - Removed a vulnerable artifact pattern from the PR-comment workflow #61
Dependencies
| Tool | Previous version | New version |
|---|---|---|
| coreutils | 9.3 | 9.5 |
| lima | 2.9.0 | 2.12.0 |
| minimap2 | 2.28 | 2.30 |
| multiqc | 1.24.1 | 1.35 |
| samtools | 1.20 | 1.23.1 |
Deprecated
- None
- New entrypoint option to skip isoseq pre-processing.
- Update the pipeline to nf-core 2.14.1.
- Update modules.
- nf-validation version pinned PR25
- Upgrade from isoseq3 to isoseq (version 4) Fix segmentation fault PR27
- Add alternative entrypoint PR10
Added
- A new entreypoint system has been implemented to allow the user where to start the analysis.
- The
isoseqentrypoint runs the full pipeline. - The
mapentrypoint runs the pipeline from the mapping step. - This new
entreypointoption make possible to use the isoseq pipeline for analysis PacBio data when subreads are not provided, or for users who want to benefit from the mapping + TAMA analysis for their Nanopore data.
Fixed
-
Update modules to their nf-test version (bamtools/convert, custom/dumpsoftwareversions, gnu/sort, gstama/collapse/ gstama/merge, gstama/polyacleanup, gunzip, isoseq/refine, lima, minimap2/align, pbccs,ultra/align, ultra/index)
-
Since isoseq3 switch to version 4, it has been rename isoseq
Tool Previous version New version bamtools/convert 2.5.2 2.5.2 isoseq 3.8.2 4.0.0 lima 2.7.1 2.9.0 minimap2/align 2.24 2.28 gnu/sort 8.25 9.3 multiqc 1.21 1.24.1
-
Update the pipeline to nf-core 2.9.
-
Add gnu/sort to sort annotation before uLTRA index
-
Update citations
-
Add background to pipeline png
-
Update modules
Tool Previous version New version isoseq3 3.8.1 3.8.2 lima 2.6.0 2.7.1 bamtools/convert 2.5.1 2.5.2 gstama/merge 1.0.2 1.0.3 uLTRA/index 0.0.4.2 0.1 uLTRA/align 0.0.4.2 0.1 samtools 1.17 1.17 gnu/sort –– 8.25
Added
- Fix issue #17. Thanks to Husen M. Umer.
- Zenodo DOI
- Update to template v2.7.2
Fixed
- Remove hard coded capped option for GSTAMA_FILELIST step. Now follow user choice. Thanks to Mazdak Salavati.
Dependencies
| Tool | Previous version | New version |
|---|---|---|
| isoseq3 | 3.4.0 | 3.8.1 |
| lima | 2.2.0 | 2.6.0 |
| minimap2 | 2.21 | 2.24 |
| samtools | 1.12 | 1.14 |
| multiqc | 1.13 | 1.14 |
| pbccs | 6.2.0 | 6.4.0 |
| ultra_bioinformatics | 0.0.4 | 0.0.4.2 |
| samtools | 1.15.1 | 1.16.1 |
Update the pipeline to nf-core template v2.5.1. Update modules:
samplesheet_checkdumpsoftwareversionMultiQC
Fix aligner option documentation.
Pipeline performance improvement.
When uLTRA path is selected, It reduce computation by indexing GTF once instead of chunk times.
nf-core/isoseq is a bioinformatics best-practice analysis pipeline for Isoseq gene annotation with uLTRA and TAMA. Starting from raw isoseq subreads, the pipeline:
- Generates the Circular Consensus Sequences (CSS)
- Clean and polish CCS to create Full Length Non Chimeric (FLNC) reads
- Maps FLNCs on the genome
- Define and clean gene models