-
Notifications
You must be signed in to change notification settings - Fork 7
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
base: master
Are you sure you want to change the base?
Conversation
📝 Walkthrough📝 WalkthroughWalkthroughThe changes introduce a new parameter, Changes
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 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. 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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 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.
There was a problem hiding this 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 messageThe 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
📒 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.
Parse regions file for samtools
Summary by CodeRabbit