Skip to content

Feat: add bbmap clumpify#52

Closed
erkutilaslan wants to merge 70 commits into
nf-core:devfrom
erkutilaslan:bbmap_clumpify
Closed

Feat: add bbmap clumpify#52
erkutilaslan wants to merge 70 commits into
nf-core:devfrom
erkutilaslan:bbmap_clumpify

Conversation

@erkutilaslan

@erkutilaslan erkutilaslan commented Oct 29, 2024

Copy link
Copy Markdown
Member

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/seqinspector branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core lint).
  • Ensure the test suite passes (nf-test test main.nf.test -profile test,docker).
  • 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).

mahesh-panchal and others added 30 commits March 19, 2024 10:09
Co-authored-by: Adrien Coulier <adrien.coulier@medsci.uu.se>
Co-authored-by: Karthik Nair <35717861+KarNair@users.noreply.github.com>
Issue with the previous implementation was that sometimes
MULTIQC_PER_LANE would execute before the extra files were collected
into `ch_multiqc_extra_files`, causing `null` to be added to the list of
files passed to multiqc.
Important! Template update for nf-core/tools v2.14.1
@github-actions

github-actions Bot commented Oct 29, 2024

Copy link
Copy Markdown

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

Posted for pipeline commit b0e2558

+| ✅ 188 tests passed       |+
!| ❗  21 tests had warnings |!
Details

❗ Test warnings:

  • readme - README contains the placeholder zenodo.XXXXXXX. This should be replaced with the zenodo doi (after the first release).
  • pipeline_todos - TODO string in main.nf: Remove this line if you don't need a FASTA file
  • pipeline_todos - TODO string in nextflow.config: Specify your pipeline's command line flags
  • pipeline_todos - TODO string in nextflow.config: Optionally, you can add a pipeline-specific nf-core config at https://github.com/nf-core/configs
  • pipeline_todos - TODO string in README.md: TODO nf-core:
  • pipeline_todos - TODO string in README.md: Include a figure that guides the user through the major workflow steps. Many nf-core
  • pipeline_todos - TODO string in README.md: Fill in short bullet-pointed list of the default steps in the pipeline
  • pipeline_todos - TODO string in README.md: Add citation for pipeline after first release. Uncomment lines below and update Zenodo doi and badge at the top of this file.
  • pipeline_todos - TODO string in README.md: Add bibliography of tools and data used in your pipeline
  • pipeline_todos - TODO string in usage.md: Add documentation about anything specific to running your pipeline. For general topics, please point to (and add to) the main nf-core website.
  • pipeline_todos - TODO string in main.nf: Optionally add in-text citation tools to this list.
  • pipeline_todos - TODO string in main.nf: Optionally add bibliographic entries to this list.
  • pipeline_todos - TODO string in main.nf: Only uncomment below if logic in toolCitationText/toolBibliographyText has been filled!
  • pipeline_todos - TODO string in test_full.config: Specify the paths to your full test data ( on nf-core/test-datasets or directly in repositories, e.g. SRA)
  • pipeline_todos - TODO string in test_full.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in test.config: Specify the paths to your test data on nf-core/test-datasets
  • pipeline_todos - TODO string in test.config: Give any required params for the test so that command line flags are not needed
  • pipeline_todos - TODO string in base.config: Check the defaults for all processes
  • pipeline_todos - TODO string in base.config: Customise requirements for specific processes.
  • pipeline_todos - TODO string in methods_description_template.yml: #Update the HTML below to your preferred methods description, e.g. add publication citation for this pipeline
  • pipeline_todos - TODO string in awsfulltest.yml: You can customise AWS full pipeline tests as required

✅ Tests passed:

Run details

  • nf-core/tools version 3.0.2
  • Run at 2024-10-29 10:46:47

@MatthiasZepper MatthiasZepper left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thank you for the contribution and working on this task!

Unfortunately, I am missing any configuration for this module. This is highly relevant for two reasons:

1.) The publishDir directive: Initially, we had decided that Seqinspector would only inspect reads, but not alter them in any way (e.g. perform adapter-trimming) However, I agree that it is convenient to be able to perform some basic error correction and optimization in the process as well. Therefore, I support the addition of such a step, but you need to publish the resulting files so they are available later in the output directory.
2.) Currently, there are no arguments defined for the tool. Particularly for tools from the BBMap Suite, the sheer amount of settings can be overwhelming, but the arguments are also very useful for advanced customization. Please read through the description of arguments and propose some decent defaults. Hint: Consider predominantly k, subs, lowcomplexity and reorder. If you would like to enable deduplication (dedupe=t) as well, choices for dupedist, scanlimit, spantiles, adjacent and optical must be made.

@maxulysse maxulysse added this to the 1.1.0 milestone Nov 6, 2025
@FranBonath FranBonath modified the milestones: 1.1.0, Overview_issues Mar 13, 2026
@maxulysse maxulysse changed the title add bbmap clumpify Feat: add bbmap clumpify Jun 12, 2026
@maxulysse maxulysse mentioned this pull request Jun 12, 2026
11 tasks
@maxulysse

Copy link
Copy Markdown
Member

Replaced by #236

@maxulysse maxulysse closed this Jun 12, 2026
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.

8 participants