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

Release v2.0.0 #45

Open
wants to merge 37 commits into
base: master
Choose a base branch
from
Open

Release v2.0.0 #45

wants to merge 37 commits into from

Conversation

charles-plessy
Copy link
Collaborator

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

I would like to release dev as version 2.0.0, to bring fixes and updates to users. Here is a copy of the changelog:

v2.0.0 "Naga imo" - [January 31st, 2025]

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

Added

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

Fixed

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

Parameters

Old parameter New parameter
--export_aln_to

Dependencies

Dependency Old version New version
LAST 1542 1608
MultiQC 1.25.1 1.27

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

nf-core-bot and others added 30 commits January 20, 2025 14:36
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.
Quoting from <https://www.debian.org/doc/debian-policy/ch-controlfields.html#version>:
> The lexical comparison is a comparison of ASCII values modified so that all the letters sort earlier than all the non-letters and so that a tilde sorts before anything, even the end of a part. For example, the following parts are in sorted order from earliest to latest: ~~, ~~a, ~, the empty part, a.

Co-authored-by: James A. Fellows Yates <[email protected]>
Important! Template update for nf-core/tools v3.1.2
Important! Template update for nf-core/tools v3.2.0
Also updated MultiQC version in CHANGELOG.md and
refreshed ro-crate-metadata.json.
Bring back merge commits from `master` to `dev`
Co-authored-by: James A. Fellows Yates <[email protected]>
CHANGELOG.md Outdated Show resolved Hide resolved
docs/images/pairgenomealign-tubemap.svg Outdated Show resolved Hide resolved
modules/nf-core/gfastats/meta.yml Show resolved Hide resolved
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