Repository navigation
docs: add guide for reproducing DIA-NN GUI runs - #88
Conversation
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.
ⓘ 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. |
|
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:
📝 WalkthroughWalkthroughDocumentation 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. ChangesDocumentation: GUI Reproduction Guide & PTM Modifications
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 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 |
This PR is against the
|
|
Description
This PR adds comprehensive documentation to help users reproduce existing DIA-NN GUI (workstation) runs using the
quantmsdiannpipeline. The new section includes:report.log.txtto equivalentquantmsdiannparametersparams.ymlconfiguration--reanalyseflagMotivation
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
docs/usage.md(lines 286–349)Checklist
docs/usage.mdis updated.https://claude.ai/code/session_01PqxesHGAKGyS2U1vsecdye
Summary by CodeRabbit