Skip to content

Commit c9f974d

Browse files
authored
Merge pull request #109 from bigbio/fix/drop-diann-extra-args
docs: drop stale diann_extra_args references (use extra_args)
2 parents 71d1bac + a2b8d48 commit c9f974d

3 files changed

Lines changed: 3 additions & 2 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212

1313
### `Changed`
1414

15+
- Removed the stale `diann_extra_args` references. The parameter was renamed to `extra_args`, but the documented worked example still used the old name — which is silently ignored, so flags such as `--smart-profiling`/`--peak-center` were dropped. The worked example now uses `extra_args`, and passing `diann_extra_args` is flagged by nf-schema parameter validation as unrecognised. Use `extra_args` (or, better, the dedicated parameters where they exist).
1516
- Documentation: clarified DIA-NN container licensing. Only DIA-NN 1.8.1 is publicly redistributable (pulled from BioContainers as the default); releases from 1.9 onward must be built locally from the [quantms-containers](https://github.com/bigbio/quantms-containers) recipes and tagged `ghcr.io/bigbio/diann:<version>` so the matching `-profile diann_v<version>` resolves them. Added the missing DIA-NN 2.5.0 row to the README support table.
1617
- QPX export now publishes the Parquet dataset files and the `.h5mu` MuData file directly under `results/qpx/`, removing the intermediate `qpx/qpx_output/` subfolder. The `bigbio/qpx` module emits the dataset as `qpx_output/*` files (bigbio/nf-modules#39) so `publishDir` can flatten them.
1718
- `--precursor_qvalue` default is now **version-aware**: unset resolves by `--diann_version` to `0.01` (1%) for DIA-NN < 2.5 and `0.05` (5%) for >= 2.5, matching DIA-NN's recommended precursor q-value. An explicit `--precursor_qvalue` always overrides and is never replaced by the version default. Applies to both the DIA-NN main report (`--qvalue`) and the MSstats input; the matrix thresholds (`--matrix_qvalue`, `--matrix_spec_q`) are unchanged.

conf/modules/dia.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
========================================================================================
33
DIA-NN module options — all DIA pipeline steps
44
========================================================================================
5-
Passes params.extra_args (formerly params.diann_extra_args) to each DIA-NN step via ext.args.
5+
Passes params.extra_args to each DIA-NN step via ext.args.
66
Blocked-flag validation is performed in each module's script block,
77
so it applies regardless of whether ext.args is overridden by the user.
88
----------------------------------------------------------------------------------------

docs/usage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ mass_acc_automatic: false # GUI used fixed tolerances; required for Bruker timsT
431431
mass_acc_ms1: 15
432432
mass_acc_ms2: 15
433433
pg_level: 2
434-
diann_extra_args: "--smart-profiling --peak-center"
434+
extra_args: "--smart-profiling --peak-center"
435435
```
436436

437437
### Common pitfalls

0 commit comments

Comments
 (0)