Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

make diann2mztab optional for large-scale datasets #42

Merged
merged 3 commits into from
Dec 16, 2024

Conversation

daichengxin
Copy link
Collaborator

@daichengxin daichengxin commented Dec 16, 2024

PR Type

Enhancement


Description

  • Added new optional flag --enable-diann2mztab (-e) to control mzTab file generation
  • Made mzTab conversion optional to improve performance for large-scale datasets
  • MSstats and Triqler output formats remain enabled by default
  • Updated package version to 0.0.18

Changes walkthrough 📝

Relevant files
Configuration changes
__init__.py
Version bump to 0.0.18                                                                     

quantmsutils/init.py

  • Bumped version from 0.0.17 to 0.0.18
+1/-1     
Enhancement
diann2mztab.py
Make mzTab conversion optional in DIA-NN processing           

quantmsutils/diann/diann2mztab.py

  • Added new enable_diann2mztab flag parameter to make mzTab conversion
    optional
  • Modified diann2mztab function to only convert to mzTab format when
    flag is enabled
  • Kept MSstats and Triqler conversions as mandatory
  • +13/-10 

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    Copy link
    Contributor

    coderabbitai bot commented Dec 16, 2024

    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.

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


    Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

    ❤️ Share
    🪧 Tips

    Chat

    There are 3 ways to chat with CodeRabbit:

    • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
      • I pushed a fix in commit <commit_id>, please review it.
      • Generate unit testing code for this file.
      • Open a follow-up GitHub issue for this discussion.
    • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
      • @coderabbitai generate unit testing code for this file.
      • @coderabbitai modularize this function.
    • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
      • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
      • @coderabbitai read src/utils.ts and generate unit testing code.
      • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
      • @coderabbitai help me debug CodeRabbit configuration file.

    Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

    CodeRabbit Commands (Invoked using PR comments)

    • @coderabbitai pause to pause the reviews on a PR.
    • @coderabbitai resume to resume the paused reviews.
    • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
    • @coderabbitai full review to do a full review from scratch and review all the files again.
    • @coderabbitai summary to regenerate the summary of the PR.
    • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
    • @coderabbitai resolve resolve all the CodeRabbit review comments.
    • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
    • @coderabbitai help to get help.

    Other keywords and placeholders

    • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
    • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
    • Add @coderabbitai anywhere in the PR title to generate the title automatically.

    CodeRabbit Configuration File (.coderabbit.yaml)

    • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
    • Please see the configuration documentation for more information.
    • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

    Documentation and Community

    • Visit our Documentation for detailed information on how to use CodeRabbit.
    • Join our Discord Community to get help, request features, and share feedback.
    • Follow us on X/Twitter for updates and announcements.

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Missing Logging
    The mzTab conversion is now optional but there's no logging to indicate whether it was enabled/disabled or when the conversion is complete

    Copy link

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    General
    Add logging for skipped operations to improve system observability and debugging

    Add logging statement to indicate when mzTab conversion is skipped to improve
    observability

    quantmsutils/diann/diann2mztab.py [182-192]

     if enable_diann2mztab:
         mztab_out = f"{Path(exp_design).stem}_out.mzTab"
         # Convert to mzTab
         diann_directory.convert_to_mztab(
             report=report,
             f_table=f_table,
             charge=charge,
             missed_cleavages=missed_cleavages,
             dia_params=dia_params,
             out=mztab_out,
         )
    +else:
    +    logger.info("Skipping mzTab conversion as enable_diann2mztab is False")
    • Apply this suggestion
    Suggestion importance[1-10]: 5

    Why: Adding a log message when mzTab conversion is skipped is a good practice for observability and debugging, though it's a minor enhancement that doesn't affect core functionality.

    5

    @ypriverol ypriverol merged commit 1ee7ee8 into bigbio:dev Dec 16, 2024
    3 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants