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

feat: parse samtools regions #40

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

fgvieira
Copy link
Contributor

@fgvieira fgvieira commented Nov 28, 2024

Parse regions file for samtools

Summary by CodeRabbit

  • New Features
    • Introduced a new parameter for enhanced handling of region files in the SAMtools options.
    • Automatically infers region files from input, improving user experience and reducing errors.

Copy link

coderabbitai bot commented Nov 28, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The changes introduce a new parameter, parse_regions, to the get_samtools_opts function within the snakemake_wrapper_utils/samtools.py file. This parameter, which defaults to True, modifies how region file options are processed. The updated function includes logic to check for specific command-line options related to region files and generates an error if those options are specified, indicating that the regions file will be inferred from the regions input file. Additionally, it appends the appropriate option to samtools_opts if a regions entry is present in snakemake.input.

Changes

File Change Summary
snakemake_wrapper_utils/samtools.py Added parse_regions parameter to get_samtools_opts. Implemented logic for handling region files, including checks for --region-file and --regions-file, and appending options to samtools_opts. Updated method signature.

Warning

Rate limit exceeded

@fgvieira has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 53 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 4d70e93 and efd5e50.


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 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

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
snakemake_wrapper_utils/samtools.py (1)

15-15: Update docstring to document the new parameter.

The new parse_regions parameter should be documented in the function's docstring to maintain consistency with other parameters.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f329b2b and 4d70e93.

📒 Files selected for processing (1)
  • snakemake_wrapper_utils/samtools.py (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
snakemake_wrapper_utils/samtools.py (1)

Pattern **/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

🔇 Additional comments (2)
snakemake_wrapper_utils/samtools.py (2)

52-62: LGTM! Implementation follows established patterns.

The regions file parsing block is well-implemented:

  • Consistent error handling with other blocks
  • Proper validation of both --region-file and --regions-file variants
  • Clear error messages
  • Follows the file's established pattern for option handling

61-62: Verify samtools regions-file option compatibility.

Let's verify that --regions-file is the correct option name across different samtools versions.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
snakemake_wrapper_utils/samtools.py (1)

32-32: Fix typo in error message

The word "infered" should be "inferred".

-                "You have specified number of threads (`-@/--threads`) in `params.extra`; this is automatically infered from `threads`."
+                "You have specified number of threads (`-@/--threads`) in `params.extra`; this is automatically inferred from `threads`."
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4d70e93 and efd5e50.

📒 Files selected for processing (1)
  • snakemake_wrapper_utils/samtools.py (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
snakemake_wrapper_utils/samtools.py (1)

Pattern **/*.py: Do not try to improve formatting.
Do not suggest type annotations for functions that are defined inside of functions or methods.
Do not suggest type annotation of the self argument of methods.
Do not suggest type annotation of the cls argument of classmethods.
Do not suggest return type annotation if a function or method does not contain a return statement.

🔇 Additional comments (3)
snakemake_wrapper_utils/samtools.py (3)

15-15: LGTM: New parameter follows established patterns

The parse_regions parameter is well-named and follows the existing pattern of boolean flags for controlling option parsing.


52-62: LGTM: Clean implementation of regions file parsing

The implementation follows the established pattern and handles both variants of the regions file option consistently.


56-59: Verify samtools CLI compatibility

Let's confirm that both --region-file and --regions-file options are valid in samtools and that --regions-file is the preferred option.

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.

1 participant