Repository navigation
removes need for PSMFeatureExtractor by always adding percolator features - #7323
Conversation
|
/describe |
|
PR Description updated to latest commit (bba2c7a) |
1 similar comment
|
PR Description updated to latest commit (bba2c7a) |
PR Analysis
PR Feedback💡 General suggestions: The changes are consistent across the files and the code seems to be well written. However, it would be beneficial to add tests to ensure the new functionality works as expected and does not introduce any regressions. 🤖 Code feedback:
✨ Usage guide:Overview: With a configuration file, use the following template:
See the review usage page for a comprehensive guide on using this tool. |
PR Code Suggestions
✨ Usage guide:Overview: With a configuration file, use the following template:
See the improve usage page for a more comprehensive guide on using this tool. |
|
Have you tried the overwriteTOPPTests tool? |
|
I don't have X!Tandem here so I just went with the manual edits during household chores ;) |
User description
Description
This PR focuses on the enhancement of several OpenMS Adapters (CometAdapter, MSFraggerAdapter, MSGFPlusAdapter, MascotAdapterOnline, XTandemAdapter) by adding percolator features to them. This is achieved by including PercolatorFeatureSetHelper.h and using its functions to add features to peptide identifications. The added features are then stored as meta values in the search parameters of protein identifications.
Checklist
How can I get additional information on failed tests during CI
Click to expand
If your PR is failing you can check outIf you click in the column that lists the failed tests you will get detailed error messages.
Advanced commands (admins / reviewer only)
Click to expand
/reformat(experimental) applies the clang-format style changes as additional commit. Note: your branch must have a different name (e.g., yourrepo:feature/XYZ) than the receiving branch (e.g., OpenMS:develop). Otherwise, reformat fails to push.rebuild jenkinswill retrigger Jenkins-based CI buildsType
Enhancement
Description
This PR focuses on the enhancement of several OpenMS Adapters (
CometAdapter,MSFraggerAdapter,MSGFPlusAdapter,MascotAdapterOnline,XTandemAdapter) by adding percolator features to them. This is achieved by includingPercolatorFeatureSetHelper.hand using its functions to add features to peptide identifications. The added features are then stored as meta values in the search parameters of protein identifications.Changes walkthrough
CometAdapter.cpp
Addition of Percolator Features to CometAdaptersrc/topp/CometAdapter.cpp
PercolatorFeatureSetHelper.hto add percolator features.MSFraggerAdapter.cpp
Addition of Percolator Features to MSFraggerAdaptersrc/topp/MSFraggerAdapter.cpp
PercolatorFeatureSetHelper.hto add percolator features.MSGFPlusAdapter.cpp
Addition of Percolator Features to MSGFPlusAdaptersrc/topp/MSGFPlusAdapter.cpp
PercolatorFeatureSetHelper.hto add percolator features.MascotAdapterOnline.cpp
Addition of Percolator Features to MascotAdapterOnlinesrc/topp/MascotAdapterOnline.cpp
PercolatorFeatureSetHelper.hto add percolator features.XTandemAdapter.cpp
Addition of Percolator Features to XTandemAdaptersrc/topp/XTandemAdapter.cpp
PercolatorFeatureSetHelper.hto add percolator features.✨ Usage guide:
Overview:
The
describetool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.When commenting, to edit configurations related to the describe tool (
pr_descriptionsection), use the following template:With a configuration file, use the following template:
Enabling\disabling automation
meaning the
describetool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description.the tool will replace every marker of the form
pr_agent:marker_namein the PR description with the relevant content, wheremarker_nameis one of the following:type: the PR type.summary: the PR summary.walkthrough: the PR walkthrough.Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.
Custom labels
The default labels of the
describetool are quite generic: [Bug fix,Tests,Enhancement,Documentation,Other].If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases.
Examples for custom labels:
Main topic:performance- pr_agent:The main topic of this PR is performanceNew endpoint- pr_agent:A new endpoint was added in this PRSQL query- pr_agent:A new SQL query was added in this PRDockerfile changes- pr_agent:The PR contains changes in the DockerfileThe list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases.
Note that Labels are not mutually exclusive, so you can add multiple label categories.
Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.
Inline File Walkthrough 💎
For enhanced user experience, the
describetool can add file summaries directly to the "Files changed" tab in the PR page.This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs).
To enable inline file summary, set
pr_description.inline_file_summaryin the configuration file, possible values are:'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab.true: A collapsable file comment with changes title and a changes summary for each file in the PR.false(default): File changes walkthrough will be added only to the "Conversation" tab.Utilizing extra instructions
The
describetool can be configured with extra instructions, to guide the model to a feedback tailored to the needs of your project.Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description.
Examples for extra instructions:
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
More PR-Agent commands
See the describe usage page for a comprehensive guide on using this tool.