Skip to content

Prepare 3.0.0#127

Merged
charles-plessy merged 37 commits into
devfrom
prepare-3.0.0
Jun 25, 2026
Merged

Prepare 3.0.0#127
charles-plessy merged 37 commits into
devfrom
prepare-3.0.0

Conversation

@charles-plessy

@charles-plessy charles-plessy commented Jun 24, 2026

Copy link
Copy Markdown
Collaborator

This prepares the 3.0.0 release.

The most important breaking changes are the upgrade of LAST and the change of some default alignment parameters, as they alter the alignment results.

Since this triggers a major version bump, I took the opportunity to add more minor breaking changes that modify file names or paths, update the CRAM encoding version, and make bigger plots. Nextflow 26.04 is now required. Users who can not upgrade to Nextflow 26.04 can still access most the most important recent developments (like the multi-genome CRAM files) in the previous version of the pipeline (2.3.0).

Breaking changes

  • Simplify output file names by removing _aln and _plt.
  • Update all modules to latest versions.
  • Use the default CRAM format from samtools (CRAM v3.1 as of samtools 1.23.1) (#86).
  • Make bigger plots, and orient sequence names vertically for the target genome (#118).
  • Increase the symmetry of the alignment by passing --gapsym and --matsym to last-train (#91).
  • Change default seed from YASS to RY128 (#121).
  • Move target genome information from cutn to targetgenome (#126).

Fixed

  • Compatible with Nextflow 26.04 "strict syntax" (#120).
  • Merge target and query genome information in a single channel (#119).
  • Extract a substitution matrix from the alignment and compute evolutionary distance indices (#102).
  • Allow FASTQ query input (#122).
  • Replace self-alignment with alignment to a different genome in the CI tests (nf-core/test-datasets#122).
  • Updated last/mafconvert to allow BCF output, and updated the module diffs so that the shared container also includes BCFtools. BCF output is experimental and output may change in minor revisions of the pipeline (#82).
  • Index BCF and CRAM files (#115).
  • Add back alignment training and result statistics that slipped out of MultiQC in version 2.3.0 (#124).

Dependencies

Dependency Old version New version
LAST 1611 1651
BCFTOOLS 1.23.1
SAMTOOLS 1.21 / 1.23.1 1.23.1 (only)
MultiQC 1.34 1.35

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/pairgenomealign branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines 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).

Closes #118

`--dotplot_width` now defaults to 1200 instead 1000 (which is a bit small
on modern screens).

`--rot1=v` is passed to last-dotplot to ensure that more sequence names
from the _target_ genome are readable.  This can be reverted with
`--dotplot_options='--rot1=h'`.
This opens the exciting possibility of aligning many targets to
many queries in the future, as opposed to just a single target and a
single query.

Also thanks to this the `main.nf` file is a pristine copy of the
version in TEMPLATE branch, which will simplify future merges.

Closes #119
Plus manual editing of README.md and nf-core rocrate
This makes it smoother for reaching one file type when having the other
name in the clipboard: only need to care about changing the file name
suffix.
Closes #122

This open the door to a future option allowing the user to align reads
to genomes using LAST, maybe in version 3.1.  Adding it now as an Easter
Egg as it will reduce the delta between the nf-core version and the
branch that I have in private to test future developments.

Alignment of reads to genomes was present in the ancestor of this
pipeline, https://github.com/oist/plessy_pairwiseGenomeComparison
This simplifies its output, allowing us to simplify the main workflow.

This also opens the door to BCF output support.
wave --freeze --conda 'bioconda::last=1651' --conda 'bioconda::samtools=1.23.1' --conda 'bioconda::bcftools=1.23.1' --conda 'conda-forge::open-fonts=0.7.0' --conda 'conda-forge::gzip=1.14' --conda 'conda-forge::bzip2=1.0.8' --conda 'conda-forge::xz=5.8.3'
Converting pairwise genome alignment to BCF is kind of heretic,
but seems to work.  This said, the feature should be considered
experimental at least in this release, with no guarantee that the
results make sense or are reproducible in the next minor release.

Closes: #82
Comment thread assets/multiqc_config.yml
Comment thread subworkflows/local/utils_nfcore_pairgenomealign_pipeline/main.nf Outdated
Comment thread subworkflows/local/utils_nfcore_pairgenomealign_pipeline/main.nf Outdated
Comment thread workflows/pairgenomealign.nf Outdated
charles-plessy and others added 3 commits June 25, 2026 09:01
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
Co-authored-by: James A. Fellows Yates <jfy133@gmail.com>
@charles-plessy charles-plessy merged commit 75f280b into dev Jun 25, 2026
8 checks passed
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.

2 participants