Repository navigation
Add --mzml_convert parameter for native Thermo .raw support - #68
Conversation
) DIA-NN 2.1.0 added native Thermo .raw support on Linux, making the ThermoRawFileParser step optional. Introduce --mzml_convert with an auto default that picks TRFP vs. native based on --diann_version, plus a version guard that rejects explicit --mzml_convert false for < 2.1.0. Emit a warning when --local_input_type under --root_folder means no .raw will reach the conversion branch (parameter is a no-op).
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ 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 |
|
|
I tested this PR locally on Linux using the test dataset (PXD026600) with both versions |
|
Hi @ypriverol , I ran the test dataset directly using the DIA-NN 2.5.0 Docker image (without the SDK installed), and it executed successfully. |
|
@yueqixuan this means this PR bigbio/quantms-containers#16 is not needed? |
|
I previously built the local image using the Dockerfile from the DIA-NN archive. I just double-checked, and dotnet-sdk-8.0 is indeed required, so this PR (bigbio/quantms-containers#16) is necessary. Once we fix the symlink issue on top of this, quantmsdiann should be able to read .raw files directly. |
|
Question here @yueqixuan @jpfeuffer @timosachsenberg @claude @copilot @enryH: Should we make raw -> .dia the default behaviour? do mzML in the middle? |
…ailure DIA-NN's native Thermo reader fails when .raw files are staged as symlinks in the Nextflow work directory (Thermo SDK limitation). Add a dynamic stageInMode closure to PRELIMINARY_ANALYSIS, INDIVIDUAL_ANALYSIS, and ASSEMBLE_EMPIRICAL_LIBRARY that switches to 'copy' staging when native .raw mode is active (DIA-NN >= 2.1.0 with mzml_convert != true), and uses 'symlink' otherwise. Extract the shared mode-detection logic into VersionUtils.isNativeRawMode() to avoid duplication across modules. Agent-Logs-Url: https://github.com/bigbio/quantmsdiann/sessions/657483e0-5833-4c95-a84d-76a61f5f5908 Co-authored-by: ypriverol <52113+ypriverol@users.noreply.github.com>
Fixed in commit |
Populate the [Unreleased] section (bumped to 2.1.0dev by the version manifest change) with entries for the --local_input_type default switch, the schema enum / runtime validation, the Bruker .d archive variants, the pride_codon_slurm resource cleanup, and the native-raw stageInMode fix merged from #68. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Description
This PR adds a new
--mzml_convertparameter to control whether Thermo.rawfiles are converted to.mzMLvia ThermoRawFileParser before being fed to DIA-NN.Motivation
DIA-NN 2.1.0 (released 2025-03-25) added native Thermo
.rawsupport on Linux, eliminating the need for conversion via ThermoRawFileParser in many cases. Skipping this conversion step saves one container invocation and an I/O pass per.rawfile — a non-trivial optimization on large datasets.However, DIA-NN's native Thermo reader has known issues on some acquisition schemes (e.g., DiaNN#1468), and conversion is still required to generate mzML-based QC statistics. This parameter provides explicit control over the behavior.
Changes
Workflow Logic (
subworkflows/local/file_preparation/main.nf):.rawfiles based on--diann_versiontrue: forces conversion via ThermoRawFileParserfalse: requires DIA-NN >= 2.1.0, passes.rawfiles directly to DIA-NN.rawis requested with DIA-NN < 2.1.0--mzml_convertis set but no.rawfiles will be processedDocumentation:
docs/usage.mdwith detailed explanation of the parameter, behavior table, and known caveatsdocs/parameters.mdwith parameter definitionnextflow_schema.jsonwith parameter schema and help textnextflow.configwith default value and inline commentsCHANGELOG.mdwith feature entryCloses
Addresses #66
PR checklist
docs/usage.mdis updated.CHANGELOG.mdis updated.nextflow_schema.jsonis updated.nextflow.configis updated with parameter defaults.https://claude.ai/code/session_01FwKnS4YJFjKMTaTg5WHy8b