Skip to content

docs: add guide for reproducing DIA-NN GUI runs - #88

Merged
ypriverol merged 3 commits into
devfrom
claude/investigate-issue-85-aiPKC
May 6, 2026
Merged

ypriverol merged 3 commits into
devfrom
claude/investigate-issue-85-aiPKC

Conversation

@ypriverol

@ypriverol ypriverol commented May 6, 2026 •

Copy link
Copy Markdown
Contributor

Description

This PR adds comprehensive documentation to help users reproduce existing DIA-NN GUI (workstation) runs using the quantmsdiann pipeline. The new section includes:

  1. Mapping table — translates DIA-NN GUI command-line flags from report.log.txt to equivalent quantmsdiann parameters
  2. Worked example — shows a complete GUI command line and its corresponding params.yml configuration
  3. Common pitfalls — highlights frequent mistakes when migrating from GUI to pipeline, including:
    • Auto mass accuracy issues with Bruker timsTOF data
    • Incorrect use of --reanalyse flag
    • Modification declaration via SDRF vs parameters
    • DIA-NN version pinning for reproducibility

Motivation

Users with existing DIA-NN GUI runs often need to reproduce those results in the pipeline. Without clear guidance, they struggle to map GUI flags to pipeline parameters, leading to configuration errors and non-reproducible results. This documentation bridges that gap.

Changes

  • Added new "Reproducing a DIA-NN GUI run" section to docs/usage.md (lines 286–349)
  • Includes detailed flag-to-parameter mapping table
  • Provides practical worked example with real command line
  • Documents common pitfalls and their solutions

Checklist

  • Usage Documentation in docs/usage.md is updated.
  • No code changes — documentation only
  • No tests needed — documentation addition

https://claude.ai/code/session_01PqxesHGAKGyS2U1vsecdye

Summary by CodeRabbit

  • Documentation
    • Introduced comprehensive guide for reproducing DIA-NN GUI runs, including parameter mapping tables, worked examples, and instructions for translating GUI settings to YAML configuration format.
    • Expanded post-translational modification site localization table with Deamidated and Methylation entries.

Adds a GUI-flag → params.yml translation table, a worked example, and
common-pitfalls callouts (auto mass accuracy on Bruker timsTOF,
--reanalyse already covered by the pipeline architecture, modifications
via SDRF, version pinning).

Addresses #85.
@qodo-code-review

Copy link
Copy Markdown
ⓘ You've reached your Qodo monthly free-tier limit. Reviews pause until next month — upgrade your plan to continue now, or link your paid account if you already have one.

@coderabbitai

coderabbitai Bot commented May 6, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 306bbdaf-3bbf-441b-8c09-82ac21a6a772

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Documentation expanded with a new GUI reproduction guide explaining how to translate DIA-NN GUI runs into quantmsdiann YAML parameters. The guide includes a mapping table, worked example, and common pitfalls section. Two new PTM modifications (Deamidated and Methylation) were added to the existing modification site-localization table.

Changes

Documentation: GUI Reproduction Guide & PTM Modifications

Layer / File(s) Summary
PTM Modifications
docs/usage.md
Added Deamidated and Methylation rows to the UniMod site-localization mapping table.
GUI Reproduction Guide
docs/usage.md
Inserted new section "Reproducing a DIA-NN GUI run" with mapping table translating GUI flags to quantmsdiann parameters, worked example converting CLI to YAML representation, and common pitfalls subsection.
Section Reorganization
docs/usage.md
"Passing Extra Arguments to DIA-NN" header repositioned after the new GUI reproduction section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A guide for the GUI-bound,
With mappings and examples abound,
YAML flows clear as a bell,
PTMs added—all's well!
The documentation hops forward unbound! 📚✨

🚥 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 title accurately and concisely describes the main addition to the PR: a guide for reproducing DIA-NN GUI runs in the documentation.
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 claude/investigate-issue-85-aiPKC

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.

@github-actions

github-actions Bot commented May 6, 2026

Copy link
Copy Markdown

This PR is against the main branch ❌

  • Do not close this PR
  • Click Edit and change the base to dev
  • This CI test will remain failed until you push a new commit

Hi @ypriverol,

It looks like this pull-request has been made against the bigbio/quantmsdiann main branch.
The main branch on nf-core repositories should always contain code from the latest release.
Because of this, PRs to main are only allowed if they come from the bigbio/quantmsdiann dev branch.

You do not need to close this PR, you can change the target branch to dev by clicking the "Edit" button at the top of this page.
Note that even after this, the test will continue to show as failing until you push a new commit.

Thanks again for your contribution!

@ypriverol
ypriverol changed the base branch from main to dev May 6, 2026 18:12
@github-actions

github-actions Bot commented May 6, 2026 •

Copy link
Copy Markdown

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

Posted for pipeline commit 75b919f

+| ✅ 108 tests passed       |+
#| ❔  18 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 4.0.2
  • Run at 2026-05-06 18:17:51

@ypriverol
ypriverol merged commit 685b4fd into dev May 6, 2026
10 of 11 checks passed
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