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

change cli to remove inputs as options #185

Merged
merged 6 commits into from
Jan 28, 2025
Merged

change cli to remove inputs as options #185

merged 6 commits into from
Jan 28, 2025

Conversation

pdimens
Copy link
Owner

@pdimens pdimens commented Jan 28, 2025

Summary by CodeRabbit

  • New Features

    • Updated command-line interface for the inline_to_haplotag.py script with simplified argument structure
    • Clarified barcode conversion key file format
  • Bug Fixes

    • None reported
  • Refactor

    • Modified Snakemake workflow rules to use temporary and compressed output files
    • Streamlined file handling in simulation workflows
  • Chores

    • Updated input/output file paths in multiple Snakemake workflow files
    • Improved file management by using compressed FASTA files

Copy link

coderabbitai bot commented Jan 28, 2025

Warning

Rate limit exceeded

@pdimens has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 20 minutes and 9 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 c8517e0 and e91ddab.

📒 Files selected for processing (1)
  • harpy/bin/inline_to_haplotag.py (1 hunks)
📝 Walkthrough

Walkthrough

The pull request introduces modifications across multiple files in the Harpy project, focusing on command-line argument parsing, workflow file configurations, and output file handling. The primary changes involve updating the inline_to_haplotag.py script to use positional arguments instead of flags for forward and reverse FASTQ files, modifying Snakemake workflow files to use temporary and compressed output files, and refining the barcode file input description.

Changes

File Change Summary
harpy/bin/inline_to_haplotag.py - Removed -f and -r flags for FASTQ files
- Added positional arguments for forward and reverse reads
- Updated help text for barcode file input
harpy/snakefiles/simulate_linkedreads.smk - Reordered arguments in inline_to_haplotag.py shell command
harpy/snakefiles/simulate_snpindel.smk - Added temp() to genome sequence outputs
- Changed FASTA outputs to gzipped format
- Updated workflow summary input files
harpy/snakefiles/simulate_variants.smk - Added temp() to genome sequence outputs
- Changed FASTA outputs to gzipped format
- Updated workflow summary input files

Possibly related PRs

Suggested labels

enhancement


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

@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

🧹 Nitpick comments (1)
harpy/bin/inline_to_haplotag.py (1)

13-13: Remove redundant required=True parameter from positional arguments.

The required=True parameter is redundant for positional arguments as they are required by default.

Apply this diff to remove the redundant parameter:

-parser.add_argument("forward", required = True, type = str, help = "Forward reads of paired-end FASTQ file pair (gzipped)")
-parser.add_argument("reverse", required = True, type = str, help = "Reverse reads of paired-end FASTQ file pair (gzipped)")
+parser.add_argument("forward", type = str, help = "Forward reads of paired-end FASTQ file pair (gzipped)")
+parser.add_argument("reverse", type = str, help = "Reverse reads of paired-end FASTQ file pair (gzipped)")

Also applies to: 17-19

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3792721 and c8517e0.

📒 Files selected for processing (4)
  • harpy/bin/inline_to_haplotag.py (1 hunks)
  • harpy/snakefiles/simulate_linkedreads.smk (2 hunks)
  • harpy/snakefiles/simulate_snpindel.smk (4 hunks)
  • harpy/snakefiles/simulate_variants.smk (4 hunks)
🔇 Additional comments (10)
harpy/snakefiles/simulate_variants.smk (4)

61-61: LGTM!

The changes improve storage efficiency by marking intermediate files as temporary and compressing output files.

Also applies to: 80-80, 84-86


116-117: LGTM!

The changes improve storage efficiency by marking intermediate files as temporary.


134-134: LGTM!

The changes improve storage efficiency by compressing output files and correctly handle file operations.

Also applies to: 136-142


147-147: LGTM!

The changes maintain consistency by updating input file paths to use the compressed file format.

Also applies to: 149-149

harpy/snakefiles/simulate_linkedreads.smk (2)

172-172: LGTM!

The command syntax is correctly updated to use positional arguments.


205-205: LGTM!

The example command in the workflow summary is correctly updated to reflect the new positional argument format.

harpy/snakefiles/simulate_snpindel.smk (4)

97-97: LGTM!

The changes improve storage efficiency by marking intermediate files as temporary.


118-118: LGTM!

The changes improve storage efficiency by compressing output files and correctly handle file operations.

Also applies to: 123-128


166-167: LGTM!

The changes improve storage efficiency by marking intermediate files as temporary.


186-186: LGTM!

The changes improve storage efficiency by compressing output files and correctly handle file operations. The input file paths are correctly updated to maintain consistency.

Also applies to: 188-194, 199-199, 201-201

@pdimens pdimens merged commit 257b831 into main Jan 28, 2025
20 checks passed
@pdimens pdimens deleted the cli-change branch January 28, 2025 19:29
This was referenced Feb 17, 2025
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