Skip to content

Dev - #61

Merged
ypriverol merged 3 commits into
mainfrom
dev
Apr 19, 2026
Merged

Dev#61
ypriverol merged 3 commits into
mainfrom
dev

Conversation

@ypriverol

@ypriverol ypriverol commented Apr 19, 2026 •

Copy link
Copy Markdown
Contributor

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 bigbio/quantmsdiann 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).

Summary by CodeRabbit

  • Documentation
    • Clarified DIA-NN image hosting information: public BioContainers for v1.8.1 and GHCR authentication for v2.x versions.
    • Added comprehensive guidance for using custom Singularity containers on HPC systems, including configuration examples and best practices for version consistency.

ypriverol and others added 3 commits April 19, 2026 08:03
Add comprehensive documentation for building and using DIA-NN
containers, addressing the common questions from issue #41:

- Pre-built container pull commands (BioContainers + GHCR)
- Two options for building containers (GitHub Actions fork vs local)
- HPC/Singularity deployment with custom config example
- Important notes about --diann_version vs -profile interaction
- Container architecture reference table

Closes #41

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Replace the verbose container section with a compact summary
and link to the comprehensive guide on the docs site
(https://quantmsdiann.quantms.org/containers/).

The full guide lives on gh-pages-source (mkdocs/containers.md)
and covers building, GHCR auth, HPC deployment, version
switching, and troubleshooting.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
docs: add container building and HPC deployment guide
@coderabbitai

coderabbitai Bot commented Apr 19, 2026 •

Copy link
Copy Markdown
📝 Walkthrough

Walkthrough

Documentation update clarifying DIA-NN image hosting and authentication requirements across versions 1.8.1 and 2.x, with a new section explaining how to configure custom containers on HPC systems using Nextflow configuration and Singularity.

Changes

Cohort / File(s) Summary
DIA-NN Container Documentation
docs/usage.md
Updated image hosting and authentication details for DIA-NN versions (1.8.1 uses public BioContainers, 2.x uses ghcr.io/bigbio). Added new section on custom container configuration for HPC with Singularity, including example Nextflow configuration, command invocation, and important usage guidelines regarding version consistency and profile conflicts.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A note was penned with care so true,
Of containers both old and new,
DIA-NN's secrets now on display,
HPC paths light up the way! 📦✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The PR title 'Dev' is vague and generic, providing no meaningful information about the changeset which contains documentation updates about DIA-NN containers and HPC deployment. Use a descriptive title that conveys the main change, such as 'docs: Add DIA-NN container setup and HPC deployment guide' to clearly communicate the documentation updates.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch dev

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/usage.md`:
- Around line 374-375: The warning about profile conflicts is too narrow:
instead of calling out only `-profile diann_v2_5_0`, update the doc text to warn
that any `diann_v*` profile which sets `process.withLabel: diann.container` will
override a local `.sif` path, and tell users to avoid combining
`--diann_version` with any `diann_v*` profile; reference the `--diann_version`
flag, the `-profile diann_v2_5_0` example, and the `process.withLabel:
diann.container` setting in the paragraph so the guidance covers all versioned
diann profiles.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7c7eeb91-7e42-4ca9-aa61-bc7d933188cb

📥 Commits

Reviewing files that changed from the base of the PR and between 1a890df and 3d277e1.

📒 Files selected for processing (1)
  • docs/usage.md

Comment thread docs/usage.md
Comment on lines +374 to +375
> [!IMPORTANT]
> Set `--diann_version` to match your container. Do **not** combine with `-profile diann_v2_5_0` (it would override your local path).

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Broaden the profile conflict warning beyond diann_v2_5_0.

The override conflict applies to any diann_v* profile that sets process.withLabel: diann.container, not just diann_v2_5_0. Narrow wording can lead users to combine other version profiles and unintentionally override their local .sif path.

✏️ Suggested doc fix
 > [!IMPORTANT]
-> Set `--diann_version` to match your container. Do **not** combine with `-profile diann_v2_5_0` (it would override your local path).
+> Set `--diann_version` to match your container. Do **not** combine this with any `diann_v*` profile (for example `diann_v2_5_0`), because those profiles set `withLabel: diann` container values and will override your local path.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
> [!IMPORTANT]
> Set `--diann_version` to match your container. Do **not** combine with `-profile diann_v2_5_0` (it would override your local path).
> [!IMPORTANT]
> Set `--diann_version` to match your container. Do **not** combine this with any `diann_v*` profile (for example `diann_v2_5_0`), because those profiles set `withLabel: diann` container values and will override your local path.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/usage.md` around lines 374 - 375, The warning about profile conflicts is
too narrow: instead of calling out only `-profile diann_v2_5_0`, update the doc
text to warn that any `diann_v*` profile which sets `process.withLabel:
diann.container` will override a local `.sif` path, and tell users to avoid
combining `--diann_version` with any `diann_v*` profile; reference the
`--diann_version` flag, the `-profile diann_v2_5_0` example, and the
`process.withLabel: diann.container` setting in the paragraph so the guidance
covers all versioned diann profiles.

@ypriverol
ypriverol merged commit 4605642 into main Apr 19, 2026
21 checks passed
@github-actions

Copy link
Copy Markdown

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

Posted for pipeline commit 3d277e1

+| ✅ 106 tests passed       |+
#| ❔  19 tests were ignored |#
#| ❔   1 tests had warnings |#
!| ❗   4 tests had warnings |!
Details

❗ Test warnings:

  • files_exist - File not found: conf/igenomes.config
  • files_exist - File not found: conf/igenomes_ignored.config
  • files_exist - File not found: .github/workflows/awstest.yml
  • files_exist - File not found: .github/workflows/awsfulltest.yml

❔ Tests ignored:

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 3.5.2
  • Run at 2026-04-19 07:17:57

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.

1 participant