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: 2.3.0 #397

Merged
merged 172 commits into from
Mar 2, 2023
Merged

Release: 2.3.0 #397

merged 172 commits into from
Mar 2, 2023

Conversation

jfy133
Copy link
Member

@jfy133 jfy133 commented Feb 27, 2023

v2.3.0 - [XXXX/XX/XX]

Added

  • #350 - Adds support for CheckM as alternative bin completeness and QC tool (added by @jfy133 and @skrakau)
  • #353 - Added the busco_clean parameter to optionally clean each BUSCO directory after a successful (by @prototaxites)
  • #361 - Added the skip_clipping parameter to skip read preprocessing with fastp or adapterremoval. Running the pipeline with skip_clipping, keep_phix and without specifying a host genome or fasta file skips the FASTQC_TRIMMED process (by @prototaxites)
  • #365 - Added CONCOCT as an additional (optional) binning tool (by @jfy133)
  • #366 - Added CAT_SUMMARISE process and cat_official_taxonomy parameter (by @prototaxites)
  • #372 - Allow CAT_DB to take an extracted database as well as a tar.gz file (by @prototaxites).
  • #380 - Added support for saving processed reads (clipped, host removed etc.) to results directory (by @jfy133)
  • #394 - Added GUNC for additional chimeric bin/contamination QC (added by @jfy13)

Changed

  • #340,#368,#373 - Update to nf-core 2.7.2 TEMPLATE (by @jfy133, @d4straub, @skrakau)
  • #373 - Removed parameter --enable_conda. Updated local modules to new conda syntax and updated nf-core modules (by @skrakau)
  • #385 - CAT also now runs on unbinned contigs as well as binned contigs (added by @jfy133)

Fixed

  • #345 - Bowtie2 mode changed to global alignment for ancient DNA mode (--very-sensitive mode) to prevent soft clipping at the end of reads when running in local mode. (by @maxibor)
  • #349 - Add a warning that pipeline will reset minimum contig size to 1500 specifically MetaBAT2 process, if a user supplies below this threshold. (by @jfy133)
  • #352 - Escape the case in the BUSCO module that BUSCO can just detect a root lineage but is not able to find any marker genes (by @alexhbnr)
  • #355 - Include error code 21 for retrying with higher memory for SPAdes and hybridSPAdes (by @mglubber)

Dependencies

Tool Previous version New version
BUSCO 5.1.0 5.4.3
BCFtools 1.14 1.16
Freebayes 1.3.5 1.3.6
SAMtools 1.15 1.16.1

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

jfy133 and others added 30 commits August 25, 2022 12:39
Co-authored-by: Daniel Straub <[email protected]>
Important! Template update for nf-core/tools v2.6
Update CHANGELOG after template merge
Bowtie2 local to global alignment for ancient DNA mode for BOWTIE2_ASSEMBLY_ALIGN
Update genome commandline parameter
@jfy133 jfy133 changed the title Dev Release: 2.3.0 Feb 27, 2023
@github-actions
Copy link

github-actions bot commented Feb 27, 2023

nf-core lint overall result: Passed ✅ ⚠️

Posted for pipeline commit 9b8cb40

+| ✅ 155 tests passed       |+
#| ❔   1 tests were ignored |#
!| ❗   2 tests had warnings |!

❗ Test warnings:

  • nextflow_config - Config manifest.version should end in dev: '2.3.0'
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your prefered methods description, e.g. add publication citation for this pipeline

❔ Tests ignored:

  • files_unchanged - File ignored due to lint config: lib/NfcoreTemplate.groovy

✅ Tests passed:

Run details

  • nf-core/tools version 2.7.2
  • Run at 2023-03-02 08:10:10

@jfy133 jfy133 requested review from skrakau and d4straub and removed request for skrakau February 27, 2023 13:13
Copy link
Collaborator

@d4straub d4straub left a comment

Choose a reason for hiding this comment

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

That are a lot of template changes... maybe we should indeed more often do minor releases right after template updates so that the release PRs are more functional changes.

LGTM.

CHANGELOG.md Outdated Show resolved Hide resolved
modules/local/bin_summary.nf Outdated Show resolved Hide resolved
modules/local/busco_plot.nf Outdated Show resolved Hide resolved
modules/local/busco_summary.nf Outdated Show resolved Hide resolved
modules/local/gtdbtk_summary.nf Outdated Show resolved Hide resolved
modules/local/mag_depths_summary.nf Outdated Show resolved Hide resolved
Comment on lines +4 to +7
conda "bioconda::multiqc=1.13"
container "${ workflow.containerEngine == 'singularity' && !task.ext.singularity_pull_docker_container ?
'https://depot.galaxyproject.org/singularity/multiqc:1.13--pyhdfd78af_0' :
'quay.io/biocontainers/multiqc:1.13--pyhdfd78af_0' }"
Copy link
Collaborator

Choose a reason for hiding this comment

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

modules/local/multiqc.nf uses 1.12, is is required to have 2 different versions?

Copy link
Member Author

@jfy133 jfy133 Feb 28, 2023

Choose a reason for hiding this comment

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

no, you guys still have a 'custom' MultiQC module - this one isn't used, but I've left it in the pipeline to make template merges easier :)

Copy link
Member

@ggabernet ggabernet left a comment

Choose a reason for hiding this comment

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

Looks good to me, just had a couple of commentss

modules/local/busco.nf Outdated Show resolved Hide resolved
modules/local/busco.nf Outdated Show resolved Hide resolved
@jfy133
Copy link
Member Author

jfy133 commented Feb 28, 2023

Waiting for a third review from @skrakau then we can go :)

docs/output.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
lib/WorkflowMag.groovy Outdated Show resolved Hide resolved
lib/WorkflowMag.groovy Outdated Show resolved Hide resolved
Copy link
Member

@skrakau skrakau left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @jfy133 :)

@jfy133 jfy133 merged commit c9468cb into master Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

9 participants