Repository navigation
Conversation
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
📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
| > [!IMPORTANT] | ||
| > Set `--diann_version` to match your container. Do **not** combine with `-profile diann_v2_5_0` (it would override your local path). |
There was a problem hiding this comment.
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.
| > [!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.
|
PR checklist
nf-core pipelines lint).nextflow run . -profile test,docker --outdir <OUTDIR>).nextflow run . -profile debug,test,docker --outdir <OUTDIR>).docs/usage.mdis updated.docs/output.mdis updated.CHANGELOG.mdis updated.README.mdis updated (including new tool citations and authors/contributors).Summary by CodeRabbit