Skip to content

Release v3.0.0 - #62

Open
sguizard wants to merge 162 commits into
masterfrom
dev
Open

Release v3.0.0#62
sguizard wants to merge 162 commits into
masterfrom
dev

Conversation

@sguizard

Copy link
Copy Markdown
Collaborator

PacBio technology has evolved, and the pipeline must follow.
I have been lucky to be involved in an Iso-Seq project which allowed me to work on the
pipeline again.

Sequencing providers used to deliver raw subreads. Nowadays the sequencing machines compute
the consensus themselves and deliver primer-free Circular Consensus Sequences directly to
the client. This major release adapts to that: an analysis can now start from the CCS, LIMA,
isoseq refine or mapping step.

The new samplesheet format introduced in version 3 lets you choose the starting step for
each listed library. Alongside it, data chunking is now controlled by two options:

  • chunk_ccs — controls chunking of the CCS step
  • chunk_mapping — splits provided FASTA files for mapping and annotation only

Warning

This is a major release with breaking changes. Samplesheets and command lines written
for v2.0.0 will not work unmodified.

  • Samplesheet is now sample,seq_data,pbi,start_from, replacing sample,bam,pbi,reads
  • --entrypoint removed — the entry point is declared per row via start_from
  • --chunk split into --chunk_ccs and --chunk_mapping
  • --max_cpus, --max_memory, --max_time removed (use resourceLimits in a config)

Migration instructions in usage.md

--primers is also no longer unconditionally required — it is needed only when at least one
row starts from ccs, lima or refine.

Version 2.1.0 was drafted but never released; its changes are included here, which is why
the version goes from 2.0.0 straight to 3.0.0.

Closes #57
Closes #50
Refs #48

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/isoseq branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

sguizard and others added 30 commits September 5, 2024 17:19
Important! Template update for nf-core/tools v3.1.1
Added an optional field `bam_type` to allow simultaneous input of both Subreads and CCS sequences
Added parameter `tama_merge_all`
@github-actions

Copy link
Copy Markdown

Warning

Newer version of the nf-core template is available.

Your pipeline is using an old version of the nf-core template: 4.0.3.
Please update your pipeline to the latest version.

For more documentation on how to update your pipeline, please see the Synchronisation documentation.

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown

nf-core pipelines lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 66d8db3

+| ✅ 262 tests passed       |+
#| ❔   3 tests were ignored |#
!| ❗   2 tests had warnings |!
Details

❗ Test warnings:

  • pipeline_todos - TODO string in nextflow.config: Specify any additional parameters here
  • pipeline_todos - TODO string in CONTRIBUTING.md: Add any pipeline specific contribution guidelines here, such as coding styles, procedures, checklists etc.

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: assets/nf-core-isoseq_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-isoseq_logo_light.png
  • files_unchanged - File ignored due to lint config: docs/images/nf-core-isoseq_logo_dark.png

✅ Tests passed:

Run details

  • nf-core/tools version 4.1.0
  • Run at 2026-08-14 19:22:52

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown

❌ nf-test failed with latest Nextflow version

Note

Tests with Nextflow's latest version failed but it will not cause a CI workflow failure.
Please check if the failure is expected with newer (edge-)releases of Nextflow or if it needs fixing.

  • conda | latest-everything | Shard 1/7

See the full run for details.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature Request: More entry points Need for Primer data from the "entrypoint" section of the pipeline

4 participants