Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Milestone 2.0.0 #39

Merged
merged 26 commits into from
Jan 30, 2025
Merged

Milestone 2.0.0 #39

merged 26 commits into from
Jan 30, 2025

Conversation

charles-plessy
Copy link
Collaborator

@charles-plessy charles-plessy commented Jan 27, 2025

This PR is intended to prepare release 2.0.0. I am bumping the major version number because the update of the aligner modules cause the updated pipeline to output results that are not bit-identical to the previous version. I expect the other changes to be non-controversial, but I welcome comments or requests about the user interface.
Here is a copy of the changelog.

v2.0.0 "Naga imo" - [January 27th, 2025]

Backwards-incompatible changes

  • The LAST software was updated and it has new defaults for some of its parameters. The alignments ran with this pipeline will not be identical to the ones from older versions.

New features

  • The alignment/lastdb directory is not output anymore. It consumed space, is not usually needed for downstream analysis, and can be re-computed identically if needed.
  • The many-to-one alignment file is not output anymore by default, to save space. To keep this file, you can run the pipeline in many-to-many mode with the --m2m parameter.
  • The --seed parameter allows for all the existing values in the lastdb program.
  • Errors caused by absence of alignments at training or plotting steps are now ignored.
  • New parameter --export_aln_to that creates additional files containing the alignments in a different format such as Axt, Chain, GFF or SAM.

Bug fixes

  • Incorrect detection of regions with 10 or more Ns was corrected (#18).
  • The --lastal_params now works as intended instead of being ignored (#22).
  • The workflow summary is now properly sorted at the end of the MultiQC report (#32).

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).

 Release v1.1.0 that adds a new softmask parameter, to optionally keep original softmasking

Merged despite linting fails, because failure is caused by template 3.0.0 release.
Release version 1.1.1
The files are not expected to be useful for downstream analyses and can
be re-created identically if they were ever needed.  Advanced users
can also override the `publishDir` directive.
The alignment files take significant amount of disk space.  Most users
of the standard mode are only interested in the _one-to-one_ alignments.
With that change, the intermediate alignment files are only kept in the
`--m2m` mode, which is expected to be selected only by users interested
in these alignments.

Closes #30.  Output is optional in the sense that one can always use
`--m2m` to get the _many-to-one_ alignment even if not interested in the
_one-to-many_.
Closes #29

When aligning a target to a large number of queries, it is sometimes
impossible to know in advance if each of them is really alignable.
Ignoring the error is a much better outcome than interrupting the
pipeline and asking the user run the pipeline again after removing
the problematic genomes from the sample sheet (or running again
with a more sensitive seed).

Errors caused by lack of memory etc. are still errors.
The update of LAST changes some alignment parameters, and therefore
can change the pipeline results.  Therefore this is a major upgrade.
Also updated MultiQC version in CHANGELOG.md and
refreshed ro-crate-metadata.json.
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General things I can't directly comment on:

  • The pipeline logo is not the correct logo, and is squished - if you need to generate a new SVg version, see nf-core pipelines create-logo

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
conf/modules.config Show resolved Hide resolved
@jfy133 jfy133 self-requested a review January 30, 2025 08:19
Copy link
Member

@jfy133 jfy133 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No blockers except the version mixing, but this is quite straight forward to fix, so I'm otherwise satisfyied ✔️

nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
nextflow_schema.json Outdated Show resolved Hide resolved
subworkflows/local/pairalign_m2m/main.nf Show resolved Hide resolved
subworkflows/local/pairalign_m2o/main.nf Show resolved Hide resolved
Copy link

@kubranarci kubranarci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! only left 2 commends

CHANGELOG.md Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
Also pull the fix for the versions channel of last/train
(see <nf-core/modules#7393>)
@charles-plessy
Copy link
Collaborator Author

Version mixing and other issues fixed!

@charles-plessy charles-plessy merged commit a09c4d4 into dev Jan 30, 2025
5 checks passed
@charles-plessy charles-plessy deleted the milestone_2.0.0 branch January 30, 2025 21:49
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.

3 participants