Skip to content

Release 2.2.0 — Chongqing - #110

Merged
ypriverol merged 59 commits into
mainfrom
dev
Jun 16, 2026
Merged

ypriverol merged 59 commits into
mainfrom
dev

Conversation

@ypriverol

@ypriverol ypriverol commented Jun 16, 2026 •

Copy link
Copy Markdown
Contributor

Release 2.2.0 — "Chongqing"

Prepares the next quantmsdiann release. This is a release PR (dev → main); no functional code changes beyond version stamping and changelog finalization — all features below were already merged into dev.

Version bump 2.2.0dev → 2.2.0

  • nextflow.config (manifest)
  • .nf-core.yml
  • ro-crate-metadata.json (was stale at 1.0.0)
  • AGENTS.md footer (version + date)

CHANGELOG finalized

Header set to [2.2.0] — Chongqing - 2026-06-16. I also backfilled changes that the merged benchmark PR (#104) and the sdrf bump never documented:

  • Added/Changed: QuantUMS now default for DIA-NN ≥ 1.9.2 (--quantums true); new --quantums_sel_runs (--quant-sel-runs, default 20).
  • Fixed (new section):
    • Multi-residue modification sites no longer silently dropped — DIA-NN truncated Phospho,79.97,S,T,Y to S only, dropping pT/pY (confirmed on PXD049692). Fixed by the sdrf-pipelines 0.1.5 bump (sites concatenated S,T,Y → STY).
    • Mass-accuracy calibration read back from PRELIMINARY_ANALYSIS logs for DIA-NN ≥ 2.5.0, with calibration > SDRF > defaults (20/10 ppm) fallback.
    • toList() (not collect()) for per-run mass-acc triples.
    • --kb + QuantUMS tuning flags registered in lib/BlockedFlags.groovy.
  • Dependencies (new section): sdrf-pipelines 0.1.4 → 0.1.5.

Highlights since 2.1.0 (all already in dev)

  • DIA-NN 2.5.1 academic profile + 2.5.1 Enterprise profile (Knowledge Base --enable_kb, --diann_license).
  • Configurable protein inference (relaxed_prot_inf / no_prot_inf); default is now DIA-NN standard inference.
  • --strip_unknown_mods to recover non-standard PTMs (e.g. hydroxyproline).
  • Version-aware --precursor_qvalue; --performance_mode now defaults to false.

Validation

  • nextflow config loads clean; no 2.2.0dev references remain.
  • Prettier + Nextflow lint (pre-commit) pass on all changed files.

Notes for reviewers / release captain

  • I edited ro-crate-metadata.json by hand — if the release flow runs nf-core pipelines bump-version / rocrate, let it regenerate the file.
  • Suggest tagging v2.2.0 on the merge commit after this merges to main (matching how v2.0.0 / v2.1.0 were cut). The manifest Zenodo concept DOI updates automatically on tag.

Summary by CodeRabbit

Release Notes – v2.2.0

  • New Features

    • Added support for DIA-NN 2.5.1 and Enterprise edition with Knowledge Base functionality
    • Introduced Enterprise license key handling for restricted builds
    • Added --strip-unknown-mods parameter for handling non-standard modifications
    • Added protein inference control options (--relaxed-prot-inf, --no-prot-inf)
    • Enabled QuantUMS by default for DIA-NN >= 1.9.2
  • Improvements

    • Version-dependent precursor q-value defaults (0.01 for <2.5, 0.05 for >=2.5)
    • Enhanced mass accuracy auto-detection for DIA-NN >= 2.5.0
    • Disabled performance-mode calibration by default
  • Documentation

    • Updated DIA-NN version support matrix and licensing constraints
    • Clarified Enterprise redistribution requirements

Yasset Perez-Riverol added 30 commits May 30, 2026 09:14
Only DIA-NN 1.8.1 is redistributable (public BioContainers, the default).
Releases 1.9+ cannot be redistributed under the DIA-NN license, so the
ghcr.io/bigbio/diann:* images are not public and must be built locally from
the quantms-containers recipes, tagged ghcr.io/bigbio/diann:<version> so the
matching -profile diann_v<version> resolves them. Add the missing 2.5.0 row to
the README support table and a matching note in docs/usage.md.
Open the 2.2.0 development cycle (manifest.version + .nf-core.yml), add a
2.2.0dev CHANGELOG section.
Datasets without a fixed modification (e.g. low-input Deep Visual Proteomics /
single-cell prep with no reduction+alkylation -> no Carbamidomethyl) failed with
'Missing or empty required SDRF columns: FixedModifications' even though the SDRF
is valid and the authors' own DIA-NN run used no fixed mod.

- Drop FixedModifications from requiredColumns (it is optional; DIA-NN runs
  without a fixed mod, and quantms-utils dianncfg guards on 'if fix_mod:').
- Default meta.fixedmodifications to '' instead of null, so the downstream
  --fix_mod flag receives an empty string rather than the literal 'null'.

Variable-only modification SDRFs (e.g. Oxidation (M) only) now run end to end.
Surfaced while benchmarking PXD064049 (Coscia FISH-guided DVP, neuroblastoma).
The test_dia_dotd database URL pointed at
databases/PXD065380.fasta (404); the FASTA actually lives at
databases/PXD065380/PXD065380.fasta in quantms-test-datasets.
Fixes the SDRF_PARSING/download failure that was breaking the
test_dia_dotd CI jobs (and fail-fast-canceling test_dia).
The test_dia_dotd database URL pointed at databases/PXD065380.fasta
(404); the FASTA actually lives at databases/PXD065380/PXD065380.fasta
in quantms-test-datasets. Fixes the download failure breaking the
test_dia_dotd CI jobs. Also re-triggers CI now that this PR targets
dev (the prior --release lint / branch-protection failures were from
when it briefly targeted main).
…older)

Publish the QPX Parquet dataset files and the .h5mu MuData file directly
under results/qpx/, removing the intermediate qpx/qpx_output/ level.

- modules/bigbio/qpx: emit the dataset as qpx_output/* files instead of the
  qpx_output/ directory (mirrors bigbio/nf-modules#39), so publishDir can
  flatten the files. A directory output and the sibling .h5mu race in
  publishDir and one is dropped, so flattening config-only is not reliable.
- conf/modules/shared.config: QPX_EXPORT publishDir now strips the
  qpx_output/ prefix via saveAs (tokenize('/').last()) and publishes to qpx/.

Pin bump for modules.json follows once bigbio/nf-modules#39 lands on main.
Docs (output.md, usage.md) already describe the flat results/qpx/ layout.
Update modules.json qpx git_sha to the merge commit of
bigbio/nf-modules#39, which emits the QPX dataset as qpx_output/* files.
Keeps nf-core check_local_copy green for the flattened output change.
docs: DIA-NN container licensing + local build (add 2.5.0); open 2.2.0dev
…bration flags by default

precursor_qvalue:
- default -> null (auto). VersionUtils.resolvePrecursorQvalue resolves by
  diann_version: <2.5 -> 0.01 (1%), >=2.5 -> 0.05 (5%). An explicit
  --precursor_qvalue always overrides (null is the only 'auto' sentinel;
  schema default removed so it is never repopulated). final_quantification
  (--qvalue) and diann_msstats (--qvalue_threshold) both use the resolver.
  Matrix thresholds (matrix_qvalue, matrix_spec_q) unchanged.

performance_mode:
- default -> false. The DIA-NN calibration speed flags
  '--min-corr 2 --corr-diff 1 --time-corr-only' can drop IDs (DIA-NN
  guidance) and are now opt-in. quick_mass_acc unchanged (still true).

Updates nextflow.config, lib/VersionUtils.groovy, the two consuming modules,
nextflow_schema.json, docs/parameters.md, CHANGELOG, and the design spec.
create_input_channel: allow empty FixedModifications (variable-only / no-alkylation SDRFs)
feat(qpx): flatten QPX export output into qpx/ (drop qpx_output/ subfolder)
feat(diann): version-aware precursor q-value + fast-mode flags off by default
…-license)

- New profile diann_v2_5_1_enterprise + conf/diann_versions/v2_5_1_enterprise.config
  (diann_version=2.5.1, diann_enterprise=true, container
  ghcr.io/bigbio/diann_enterprise:2.5.1; bundles binary+KB, no license).
- New params: diann_enterprise (false), enable_kb (false), diann_license (null).
- --enable_kb adds DIA-NN --kb only to PRELIMINARY_ANALYSIS (first-pass search);
  ignored in second pass / library creation. Gated on diann_enterprise (errors
  otherwise); warns if enabled without a license.
- --diann_license stages the key into all 6 DIA-NN binary processes as --license,
  with fallback to a key next to the binary when unset. The key is a per-user
  secret and is never committed or bundled into the shared image.
- Schema, parameters.md, usage.md (Enterprise section), README support row, CHANGELOG.

Verified: config parses for default + enterprise profiles, resolver/guards wired,
nextflow lint (no real DSL errors), nf-core lint 0 failures, format hooks clean.
feat(diann): DIA-NN Enterprise 2.5.1 support (--kb knowledge base + --license)
params_<timestamp>.json records launch-time pipeline parameters only.
Modifications, enzyme and mass tolerances are taken from the SDRF per
sample at runtime and override the defaults shown there (fixed mods and
enzyme have no parameter at all, so they never appear in params.json).
Document that the authoritative resolved values live in
results/sdrf/diann_config.cfg + the SDRF, and add an 'SDRF parsing
outputs' section describing sdrf/. No behavior change.
New conf/diann_versions/v2_5_1.config + profile diann_v2_5_1
(container ghcr.io/bigbio/diann:2.5.1), the academic counterpart to the
2.5.1 Enterprise build. README + usage version tables and CHANGELOG updated.
docs: clarify params.json vs SDRF-derived parameters (mods, enzyme, tolerances)
--kb was only added to PRELIMINARY_ANALYSIS, which is the quick mass-accuracy
calibration pass — not where identification happens. The Knowledge Base
boosts IDs and belongs on the actual search steps. Add --kb (gated by
params.enable_kb) to ASSEMBLE_EMPIRICAL_LIBRARY (first-pass search that builds
the empirical library) and INDIVIDUAL_ANALYSIS (per-file search); clarify the
PRELIMINARY_ANALYSIS comment. Found during the ProteoBench benchmark review
(reported by V. Demichev).
params.quantums defaulted to false, which forced --direct-quant on every
DIA-NN >= 1.9.2 run and thereby disabled QuantUMS (DIA-NN's recommended
quantification), affecting quantification accuracy. Flip the default to true.
The --direct-quant opt-out remains version-gated in FINAL_QUANTIFICATION, so
DIA-NN 1.8.1 (no QuantUMS) is unaffected; only >= 1.9.2 now uses QuantUMS.
Yasset Perez-Riverol added 22 commits June 9, 2026 01:30
fix(diann): benchmark-review bug fixes (--kb, QuantUMS, mass-accuracy, --no-prot-inf)
0.1.4's parse_sdrf convert-diann emits multi-residue modification sites
comma-separated (e.g. Phospho,79.966331,S,T,Y), which DIA-NN truncates to the
first residue only (S) -- silently dropping pT/pY (confirmed on PXD049692) and
any modification on multiple residues. 0.1.5 fixes the converter to concatenate
sites (S,T,Y -> STY, M,P -> MP).

Container verified published: biocontainers/sdrf-pipelines:0.1.5--pyhdfd78af_0
(bioconda latest_version 0.1.5).
chore: bump sdrf-pipelines 0.1.4 -> 0.1.5 (fixes multi-residue mod site truncation)
The DIA-NN >= 2.5.0 mass-accuracy branch maps each PRELIMINARY log to a
[ms2,ms1,sw] triple, then aggregates. collect() FLATTENS nested lists, so the
downstream .map received a flat list of Doubles and 'it[0]' threw
'Unknown method invocation getAt on Double type' at runtime. toList() collects
the per-run triples without flattening. Caught by the Module 7 / DIA-NN 2.5.1
cluster validation (CI only exercises <2.5.0, which takes the other branch).
fix(diann): use toList() not collect() for per-run mass-acc triples (runtime crash on DIA-NN >= 2.5.0)
…in_inference)

FINAL_QUANTIFICATION hardcoded --no-prot-inf (#104). Make it a param:
relaxed_protein_inference=false (default) -> --no-prot-inf (reuse empirical-library
inference); true -> --relaxed-prot-inf (re-infer in final). Enables an A/B to test
whether --no-prot-inf is what lifts 1.8.1 protein counts and erases the 1.8.1->2.5
run-specific protein advantage Vadim expects (+12%/+18%).
The parameter was renamed to 'extra_args', but the worked example in
docs/usage.md still used the old 'diann_extra_args' name. That name is no
longer read by the pipeline, so it is silently ignored — flags like
--smart-profiling/--peak-center were dropped without warning. Update the
example to 'extra_args' and remove the lingering 'formerly diann_extra_args'
note from conf/modules/dia.config. Passing 'diann_extra_args' is now flagged
by nf-schema as an unrecognised parameter rather than silently doing nothing.
…-standard PTMs

Some declared variable modifications are not recognised by the DIA-NN
deep-learning predictor — most notably Oxidation on proline (hydroxyproline),
ubiquitous in collagen/ECM. During in-silico library generation DIA-NN
silently SKIPS those precursors (log: 'skipping N precursors, unrecognised
modifications'), so they never enter the library and are never identified.

Add a first-class boolean param 'strip_unknown_mods' (default false). It is
assembled into each DIA-NN module's command (like met_excision/aa_eq) rather
than injected via extra_args, matching the pipeline's design. When enabled,
--strip-unknown-mods is added to all DIA-NN steps, forcing DIA-NN to predict
spectra/RTs/IMs for the unrecognised-mod peptidoforms so they are retained
and searchable. No-op when every declared modification is recognised.

- nextflow.config + nextflow_schema.json: new strip_unknown_mods param.
- modules/local/diann/*: INSILICO_LIBRARY_GENERATION, PRELIMINARY_ANALYSIS,
  ASSEMBLE_EMPIRICAL_LIBRARY, INDIVIDUAL_ANALYSIS, FINAL_QUANTIFICATION all
  add ${strip_unknown_mods} to the diann command.
- docs/usage.md: GUI-flag mapping row + Common pitfalls note (incl. the
  Trypsin/P enzyme for --cut K*,R*, declared in the SDRF, for collagen).
- CHANGELOG.
…o-prot-inf opt-in

Per DIA-NN docs, --relaxed-prot-inf (FragPipe/Spectronaut-style grouping) and
--no-prot-inf (reuse library inference) are both OPT-IN deviations from DIA-NN's
default standard inference. The pipeline was forcing --relaxed-prot-inf
(INDIVIDUAL_ANALYSIS) and --no-prot-inf (FINAL, #104) -- both non-default.

Replace with two mutually-exclusive opt-in params (relaxed_prot_inf / no_prot_inf,
default false) applied to INDIVIDUAL_ANALYSIS + FINAL_QUANTIFICATION. Default (both
off) = DIA-NN standard inference -- what a typical user gets. Benchmarks opt into
whichever inference a given comparison needs (Vadim's guidance). Supersedes the
single relaxed_protein_inference toggle.
docs: drop stale diann_extra_args references (use extra_args)
feat(diann): add --strip_unknown_mods to recover hydroxyproline / non-standard PTMs
…rgs)

The dev merge conflict resolution wrongly kept diann_extra_args alongside
strip_unknown_mods. diann_extra_args was removed on dev in favor of extra_args
(7737952 'remove diann_ prefix', a2b8d48 'drop stale diann_extra_args references').
Remove it from nextflow.config + schema so the branch matches dev.
Remove --kb (preliminary/assemble/individual), QuantUMS (final), and protein-inference
(individual) inline comments — they duplicate the enable_kb / quantums / quantums_sel_runs /
relaxed_prot_inf / no_prot_inf parameter descriptions in nextflow.config + schema. Genuine
logic comments (toList gotcha, mass-accuracy version behaviour, validation guards) kept.
Address CodeRabbit review of #107: the usage.md flag table claimed --relaxed-prot-inf
is 'Always set' (now stale -- it's opt-in via relaxed_prot_inf, default = DIA-NN
standard inference), and the CHANGELOG only documented strip_unknown_mods. Update the
row and add a CHANGELOG entry for the new protein-inference params.
- usage.md: add a 'Protein inference' section — DIA-NN default is heuristic inference
  (no flag); relaxed_prot_inf/no_prot_inf are mutually-exclusive opt-ins on INDIVIDUAL +
  FINAL; PRELIMINARY is fixed --no-prot-inf (calibration); INSILICO/ASSEMBLE do none.
- BlockedFlags: refresh the INDIVIDUAL/FINAL comments (protein inference is now managed
  by the relaxed_prot_inf/no_prot_inf params, not hardcoded), and also block
  --relaxed-prot-inf in PRELIMINARY so extra_args can't add inference to the calibration pass.
…-liners

The detailed explanation lives in usage.md; keep the code comments terse.
Cite DIA-NN discussions: default = heuristic inference, on by default (#680);
--relaxed-prot-inf worked example A;B vs A (#107); 'keep defaults' guidance (#316).
Clarify that --no-prot-inf is a deliberate deviation, not a DIA-NN documented default.
Re-pad the GUI-flag table (widened by the relaxed-prot-inf row) and switch
emphasis to _italic_, per prettier@3.8.3 / .prettierrc.yml.
feat(diann): protein inference defaults to DIA-NN standard; relaxed/no-prot-inf opt-in
- Stamp version 2.2.0 in nextflow.config, .nf-core.yml, ro-crate-metadata.json
- Finalize CHANGELOG [2.2.0] header with codename + date (2026-06-16)
- Document QuantUMS-by-default (>=1.9.2), --quantums_sel_runs, mass-accuracy
  calibration fixes, BlockedFlags additions, and sdrf-pipelines 0.1.5 bump
- Refresh AGENTS.md version/date footer
@qodo-code-review

ghost commented Jun 16, 2026

Copy link
Copy Markdown

Qodo reviews are paused for this user.

Troubleshooting steps vary by plan Learn more →

On a Teams plan?
Reviews resume once this user has a paid seat and their Git account is linked in Qodo.
Link Git account →

Using GitHub Enterprise Server, GitLab Self-Managed, or Bitbucket Data Center?
These require an Enterprise plan - Contact us
Contact us →

@github-actions

ghost commented Jun 16, 2026 •

Copy link
Copy Markdown

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

Posted for pipeline commit f4a1f41

+| ✅ 109 tests passed       |+
#| ❔  18 tests were ignored |#
#| ❔   1 tests had warnings |#
!| ❗   5 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
  • included_configs - Pipeline config does not include custom configs. Please add the includeConfig line.

❔ Tests ignored:

❔ Tests fixed:

✅ Tests passed:

Run details

  • nf-core/tools version 4.0.2
  • Run at 2026-06-16 08:27:58

@coderabbitai

ghost commented Jun 16, 2026 •

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Release 2.2.0 adds DIA-NN 2.5.1 and Enterprise support (new profiles, per-process license injection, --kb, --strip-unknown-mods, protein-inference toggles), a version-aware precursor q-value resolver (VersionUtils.resolvePrecursorQvalue), version-conditional calibration log parsing in the main workflow, QPX output glob flattening, optional SDRF FixedModifications handling, sdrf-pipelines 0.1.5 bump, and updated schema/config defaults.

Changes

quantmsdiann v2.2.0

Layer / File(s) Summary
Schema and config default changes
nextflow.config, nextflow_schema.json
Adds Enterprise params (diann_enterprise, enable_kb, diann_license), strip_unknown_mods, protein inference toggles (relaxed_prot_inf, no_prot_inf), and strip_unknown_mods to schema and config; changes precursor_qvalue default to null, performance_mode to false, quantums to true, quantums_sel_runs to 20, and adjusts mass accuracy defaults.
DIA-NN v2.5.1 and Enterprise config profiles
conf/diann_versions/v2_5_1.config, conf/diann_versions/v2_5_1_enterprise.config, nextflow.config
Adds config files for academic and Enterprise 2.5.1 containers and registers them as named profiles in nextflow.config.
VersionUtils q-value resolver and BlockedFlags guards
lib/VersionUtils.groovy, lib/BlockedFlags.groovy
Adds VersionUtils.resolvePrecursorQvalue() returning a version-derived 0.01/0.05 default when precursor_qvalue is null; expands BlockedFlags to strip --kb and --relaxed-prot-inf in relevant pipeline steps.
Enterprise license and flag wiring in DIA-NN process modules
modules/local/diann/*/main.nf, conf/modules/dia.config
Adds path(diann_license) input and computes license_arg, kb, strip_unknown_mods, prot_inf, and resolved precursor_qvalue CLI variables in all six DIA-NN local processes and the MSstats module; injects each into the DIA-NN command line; renames diann_extra_args → extra_args in the module config.
DIA workflow validation, license channel, and calibration parsing
workflows/dia.nf
Adds mutual-exclusion validation for protein-inference options and Enterprise/KB guards; creates ch_diann_license and threads it through all DIA-NN process calls; rewrites calibration log parsing to be version-conditional (≥ 2.5.0 averages PRELIMINARY_ANALYSIS logs; older versions use ASSEMBLE_EMPIRICAL_LIBRARY logs).
QPX output glob and publish-path flattening
modules/bigbio/qpx/main.nf, modules/bigbio/qpx/meta.yml, conf/modules/shared.config, modules.json
Changes QPX_EXPORT output from emitting the directory to qpx_output/* glob; updates meta.yml type from directory to file; flattens published paths under qpx/ via tokenize('/').last() in shared.config; bumps qpx module git_sha.
SDRF FixedModifications optional and sdrf-pipelines 0.1.5
subworkflows/local/create_input_channel/main.nf, modules/local/sdrf_parsing/main.nf, conf/tests/test_dia_dotd.config
Makes FixedModifications a non-required SDRF column (defaults to ''); bumps sdrf-pipelines container to 0.1.5; updates test FASTA URL.
Documentation, design docs, and version metadata
README.md, docs/usage.md, docs/parameters.md, docs/output.md, docs/design/*, CHANGELOG.md, AGENTS.md, .nf-core.yml, ro-crate-metadata.json
Adds Enterprise design docs and recommended-defaults design; updates README container/licensing table; updates usage.md with v2.5.1 profiles, GUI mapping revisions, Enterprise section; updates parameter defaults in parameters.md; adds SDRF source-of-truth note in output.md; bumps all version strings to 2.2.0.

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant dia_nf as workflows/dia.nf
  participant ch_diann_license
  participant PRELIMINARY_ANALYSIS
  participant ASSEMBLE_EMPIRICAL_LIBRARY
  participant INDIVIDUAL_ANALYSIS
  participant FINAL_QUANTIFICATION

  User->>dia_nf: params.diann_license / params.enable_kb / params.diann_enterprise
  dia_nf->>dia_nf: validate protein-inference mutual exclusion
  dia_nf->>dia_nf: validate Enterprise/KB guards
  dia_nf->>ch_diann_license: create channel from params.diann_license (or [])
  dia_nf->>PRELIMINARY_ANALYSIS: ch_diann_license → --kb, --license, --strip-unknown-mods, --aa-eq
  alt diann_version >= 2.5.0
    PRELIMINARY_ANALYSIS-->>dia_nf: logs → parse MS1/MS2/scan-window, average across runs
  else diann_version < 2.5.0
    dia_nf->>ASSEMBLE_EMPIRICAL_LIBRARY: ch_diann_license → --license, --kb
    ASSEMBLE_EMPIRICAL_LIBRARY-->>dia_nf: logs → parse "Averaged recommended settings"
  end
  dia_nf->>INDIVIDUAL_ANALYSIS: ch_diann_license + calibrated values → --license, --kb, --prot-inf
  dia_nf->>FINAL_QUANTIFICATION: ch_diann_license → --license, --qvalue (resolved), --prot-inf, --quantums
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related issues

  • bigbio/quantms#665: This PR directly implements the QuantUMS-by-default behavior (Task 2a) described in the issue — quantums defaults to true, quantums_sel_runs to 20, and FINAL_QUANTIFICATION is updated accordingly.

Possibly related PRs

  • bigbio/quantmsdiann#88: Both PRs revise the DIA-NN GUI-to-pipeline flag mapping table and surrounding usage guidance in docs/usage.md.
  • bigbio/quantmsdiann#98: This PR includes the same FixedModifications optional change in subworkflows/local/create_input_channel/main.nf (default to '', remove from required columns).
  • bigbio/quantmsdiann#82: This PR's QPX output glob and publish-path flattening directly extends the QPX_EXPORT module introduced in PR #82.

Suggested reviewers

  • yueqixuan
  • daichengxin

Poem

🐇 Hop hop, the rabbit types away,
Enterprise licenses here to stay!
KB flags and q-values auto-tuned,
QPX globs now properly groomed.
Version two-point-two lands today —
QuantUMS on, and defaults sane, hooray! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'Release 2.2.0 — Chongqing' accurately reflects the main objective of this release PR, which is to publish version 2.2.0 of the quantmsdiann workflow pipeline.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ 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.

@ypriverol
ypriverol requested a review from yueqixuan June 16, 2026 08:32

ghost 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: 4

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
nextflow_schema.json (1)

453-458: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Enforce the documented lower bound for quantums_sel_runs.

The help text says N must be 6 or greater, but schema currently accepts smaller integers.

Suggested patch
                 "quantums_sel_runs": {
                     "type": "integer",
+                    "minimum": 6,
                     "description": "Number of automatically selected runs for QuantUMS training.",
                     "fa_icon": "fas fa-sliders-h",
                     "help_text": "Sets the DIA-NN parameter --quant-sel-runs. Format: [N]. QuantUMS will train its parameters on N automatically selected runs to speed up training in large experiments. N must be 6 or greater.",
                     "default": 20,
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@nextflow_schema.json` around lines 453 - 458, The quantums_sel_runs field
definition lacks validation that enforces the documented constraint from the
help text. Add a minimum property constraint to the quantums_sel_runs integer
field definition to ensure the value must be 6 or greater, matching the
documented requirement that states "N must be 6 or greater".
🧹 Nitpick comments (1)
modules/local/diann/individual_analysis/main.nf (1)

75-86: ⚡ Quick win

Use single quotes for non-interpolated string literals in .nf modules.

The same style rule is violated in multiple touched modules: constant flags use double quotes where no interpolation is needed.

  • modules/local/diann/individual_analysis/main.nf#L75-L86: switch constant literals like --strip-unknown-mods, --relaxed-prot-inf, --no-prot-inf, --kb empty fallbacks to single-quoted strings.
  • modules/local/diann/assemble_empirical_library/main.nf#L36-L36: switch the --kb and empty fallback literals to single-quoted strings.
  • modules/local/diann/assemble_empirical_library/main.nf#L52-L52: switch --strip-unknown-mods and empty fallback literals to single-quoted strings.
  • modules/local/diann/final_quantification/main.nf#L55-L67: switch constant literals (protein inference / quantums / strip-unknown-mods branches) to single-quoted strings where no interpolation occurs.

As per coding guidelines, **/*.nf: use single quotes for strings ('text') unless string interpolation is needed ("$var").

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@modules/local/diann/individual_analysis/main.nf` around lines 75 - 86, Switch
all non-interpolated string literals from double quotes to single quotes across
four files to follow the Nextflow coding style guideline. In
modules/local/diann/individual_analysis/main.nf lines 75-86, replace double
quotes with single quotes for constant flag strings like --strip-unknown-mods,
--quant-tims-sum, --im-window, --dda, --no-ifs-removal, --no-main-report,
--license, --relaxed-prot-inf, --no-prot-inf, --kb, and empty string fallbacks.
In modules/local/diann/assemble_empirical_library/main.nf line 36, switch the
--kb flag and empty fallback to single quotes. In
modules/local/diann/assemble_empirical_library/main.nf line 52, switch
--strip-unknown-mods and empty fallback literals to single quotes. In
modules/local/diann/final_quantification/main.nf lines 55-67, switch all
constant flag literals in the protein inference, quantums, and
strip-unknown-mods branches to single quotes where no string interpolation
occurs. Only keep double quotes where the string contains variable interpolation
(like with $params or $diann_license).

Source: Coding guidelines

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@lib/BlockedFlags.groovy`:
- Around line 74-77: The --license flag is now pipeline-managed but is not
included in the blocked flags list, allowing users to override it through
extra_args in module commands. Add --license to the blocked flags list in
BlockedFlags.groovy at lines 74-77 (anchor location where --kb and --no-prot-inf
are blocked), and also at the sibling locations at lines 90-91 and 103-104.
Include --license as a blocked flag alongside other pipeline-managed flags to
prevent users from overriding the intended license configuration.

In `@nextflow_schema.json`:
- Around line 315-320: The `diann_license` parameter in nextflow_schema.json
currently only validates the format as a file-path but does not check if the
file actually exists, which can lead to failures during module execution rather
than at validation time. Add an existence validation check to the
`diann_license` parameter definition (the one with type string/null around line
315-320) to ensure the specified file exists before execution begins, allowing
runs to fail fast with clear feedback about missing or incorrectly specified
license files.

In `@subworkflows/local/create_input_channel/main.nf`:
- Around line 174-179: The code in main.nf now intentionally excludes
FixedModifications from the requiredColumns object, treating it as optional for
label-free and low-input experiments. Update the nextflow_schema.json file to
modify the documentation for fixed_mods to reflect that it is optional rather
than required from SDRF, ensuring the help text aligns with the actual
validation logic that now permits missing FixedModifications.
- Around line 164-172: In the create_input_channel workflow when multiple
FixedModifications are detected in the fixedMods list (fixedMods.size() > 1),
the code currently only logs an error but continues execution and picks the
first value. To fail fast and prevent silent generation of incorrect DIA-NN
configs, replace the log.error() call with Nextflow's error() function to
immediately halt the workflow when this conflict is detected, ensuring the SDRF
issue is addressed before proceeding.

---

Outside diff comments:
In `@nextflow_schema.json`:
- Around line 453-458: The quantums_sel_runs field definition lacks validation
that enforces the documented constraint from the help text. Add a minimum
property constraint to the quantums_sel_runs integer field definition to ensure
the value must be 6 or greater, matching the documented requirement that states
"N must be 6 or greater".

---

Nitpick comments:
In `@modules/local/diann/individual_analysis/main.nf`:
- Around line 75-86: Switch all non-interpolated string literals from double
quotes to single quotes across four files to follow the Nextflow coding style
guideline. In modules/local/diann/individual_analysis/main.nf lines 75-86,
replace double quotes with single quotes for constant flag strings like
--strip-unknown-mods, --quant-tims-sum, --im-window, --dda, --no-ifs-removal,
--no-main-report, --license, --relaxed-prot-inf, --no-prot-inf, --kb, and empty
string fallbacks. In modules/local/diann/assemble_empirical_library/main.nf line
36, switch the --kb flag and empty fallback to single quotes. In
modules/local/diann/assemble_empirical_library/main.nf line 52, switch
--strip-unknown-mods and empty fallback literals to single quotes. In
modules/local/diann/final_quantification/main.nf lines 55-67, switch all
constant flag literals in the protein inference, quantums, and
strip-unknown-mods branches to single quotes where no string interpolation
occurs. Only keep double quotes where the string contains variable interpolation
(like with $params or $diann_license).
🪄 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: c184ef5a-49ad-4c02-a0d2-581464caf554

📥 Commits

Reviewing files that changed from the base of the PR and between 9af0b39 and f4a1f41.

📒 Files selected for processing (32)
  • .nf-core.yml
  • AGENTS.md
  • CHANGELOG.md
  • README.md
  • conf/diann_versions/v2_5_1.config
  • conf/diann_versions/v2_5_1_enterprise.config
  • conf/modules/dia.config
  • conf/modules/shared.config
  • conf/tests/test_dia_dotd.config
  • docs/design/2026-06-02-diann-recommended-defaults-design.md
  • docs/design/2026-06-03-diann-enterprise-design.md
  • docs/output.md
  • docs/parameters.md
  • docs/usage.md
  • lib/BlockedFlags.groovy
  • lib/VersionUtils.groovy
  • modules.json
  • modules/bigbio/qpx/main.nf
  • modules/bigbio/qpx/meta.yml
  • modules/local/diann/assemble_empirical_library/main.nf
  • modules/local/diann/diann_msstats/main.nf
  • modules/local/diann/final_quantification/main.nf
  • modules/local/diann/fine_tune_models/main.nf
  • modules/local/diann/individual_analysis/main.nf
  • modules/local/diann/insilico_library_generation/main.nf
  • modules/local/diann/preliminary_analysis/main.nf
  • modules/local/sdrf_parsing/main.nf
  • nextflow.config
  • nextflow_schema.json
  • ro-crate-metadata.json
  • subworkflows/local/create_input_channel/main.nf
  • workflows/dia.nf

Comment thread lib/BlockedFlags.groovy
Comment on lines +74 to +77
// Pipeline-managed: Enterprise Knowledge Base, gated by params.enable_kb
'--kb',
// Calibration pass: protein inference off (--no-prot-inf hard-coded)
'--no-prot-inf', '--relaxed-prot-inf',

ghost Jun 16, 2026

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 | 🟠 Major | ⚡ Quick win

Block --license in extra_args to prevent managed-flag override.

--license is now pipeline-managed, but it is not blocked here. Since module commands append $args after ${license_arg} (Line 86 in modules/local/diann/insilico_library_generation/main.nf, Line 116 in modules/local/diann/preliminary_analysis/main.nf), user extra_args can override or duplicate the intended license flag.

Suggested patch
     private static final List<String> COMMON = [
         '--temp', '--threads', '--verbose', '--lib', '--f', '--fasta',
         '--monitor-mod', '--var-mod', '--fixed-mod', '--dda', '--parent', '--aa-eq',
         '--channels', '--lib-fixed-mod', '--original-mods',
         '--proteoforms', '--peptidoforms', '--no-peptidoforms',
+        '--license',
     ]

Also applies to: 90-91, 103-104

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@lib/BlockedFlags.groovy` around lines 74 - 77, The --license flag is now
pipeline-managed but is not included in the blocked flags list, allowing users
to override it through extra_args in module commands. Add --license to the
blocked flags list in BlockedFlags.groovy at lines 74-77 (anchor location where
--kb and --no-prot-inf are blocked), and also at the sibling locations at lines
90-91 and 103-104. Include --license as a blocked flag alongside other
pipeline-managed flags to prevent users from overriding the intended license
configuration.

Comment thread nextflow_schema.json
Comment on lines +315 to +320
"diann_license": {
"type": ["string", "null"],
"format": "file-path",
"description": "Path to the DIA-NN Enterprise license key, passed as --license. Leave unset to rely on a key bundled next to the binary. The key is a per-user secret — never commit it.",
"fa_icon": "fas fa-key"
},

ghost Jun 16, 2026

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 | ⚡ Quick win

Validate diann_license existence during schema checks.

format: "file-path" alone won’t catch typoed or missing key files early. Add an existence check so runs fail fast before module execution.

Suggested patch
                 "diann_license": {
                     "type": ["string", "null"],
                     "format": "file-path",
+                    "exists": true,
                     "description": "Path to the DIA-NN Enterprise license key, passed as --license. Leave unset to rely on a key bundled next to the binary. The key is a per-user secret — never commit it.",
                     "fa_icon": "fas fa-key"
                 },
📝 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
"diann_license": {
"type": ["string", "null"],
"format": "file-path",
"description": "Path to the DIA-NN Enterprise license key, passed as --license. Leave unset to rely on a key bundled next to the binary. The key is a per-user secret — never commit it.",
"fa_icon": "fas fa-key"
},
"diann_license": {
"type": ["string", "null"],
"format": "file-path",
"exists": true,
"description": "Path to the DIA-NN Enterprise license key, passed as --license. Leave unset to rely on a key bundled next to the binary. The key is a per-user secret — never commit it.",
"fa_icon": "fas fa-key"
},
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@nextflow_schema.json` around lines 315 - 320, The `diann_license` parameter
in nextflow_schema.json currently only validates the format as a file-path but
does not check if the file actually exists, which can lead to failures during
module execution rather than at validation time. Add an existence validation
check to the `diann_license` parameter definition (the one with type string/null
around line 315-320) to ensure the specified file exists before execution
begins, allowing runs to fail fast with clear feedback about missing or
incorrectly specified license files.

Comment on lines 164 to +172
if (fixedMods.size() > 1) {
log.error("SDRF conflict: Multiple FixedModifications (${fixedMods.join(',')}) found for file ${meta.id}. Please fix the SDRF.")
}
meta.fixedmodifications = fixedMods ? fixedMods[0] : null

// Validate required SDRF columns
// Empty string (not null) when no fixed mod is declared: null would be
// interpolated as the literal "null" into the downstream --fix_mod flag.
// No fixed modification is valid (e.g. low-input DVP / single-cell prep
// without reduction+alkylation, so no Carbamidomethyl); DIA-NN and
// quantms-utils dianncfg both run fine with an empty fixed-mod set.
meta.fixedmodifications = fixedMods ? fixedMods[0] : ''

ghost Jun 16, 2026

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 | 🟠 Major | ⚡ Quick win

Fail fast on conflicting FixedModifications values.

When multiple fixed-mod values are found for the same file, the code logs an error but continues and picks the first value. That can silently generate the wrong DIA-NN config.

Proposed fix
     if (fixedMods.size() > 1) {
         log.error("SDRF conflict: Multiple FixedModifications (${fixedMods.join(',')}) found for file ${meta.id}. Please fix the SDRF.")
+        exit(1)
     }
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@subworkflows/local/create_input_channel/main.nf` around lines 164 - 172, In
the create_input_channel workflow when multiple FixedModifications are detected
in the fixedMods list (fixedMods.size() > 1), the code currently only logs an
error but continues execution and picks the first value. To fail fast and
prevent silent generation of incorrect DIA-NN configs, replace the log.error()
call with Nextflow's error() function to immediately halt the workflow when this
conflict is detected, ensuring the SDRF issue is addressed before proceeding.

Comment on lines +174 to 179
// Validate required SDRF columns. FixedModifications is intentionally NOT
// required: many label-free / low-input experiments declare no fixed mod.
def requiredColumns = [
'Label': meta.labelling_type,
'Enzyme': meta.enzyme,
'FixedModifications': meta.fixedmodifications
'Enzyme': meta.enzyme
]

ghost Jun 16, 2026

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 | ⚡ Quick win

Update the schema/help contract to match optional FixedModifications.

This file now treats missing FixedModifications as valid, but nextflow_schema.json help text still states fixed_mods is required from SDRF. Please align that documentation to avoid contradictory user guidance.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@subworkflows/local/create_input_channel/main.nf` around lines 174 - 179, The
code in main.nf now intentionally excludes FixedModifications from the
requiredColumns object, treating it as optional for label-free and low-input
experiments. Update the nextflow_schema.json file to modify the documentation
for fixed_mods to reflect that it is optional rather than required from SDRF,
ensuring the help text aligns with the actual validation logic that now permits
missing FixedModifications.

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.

2 participants