snakemake / snakemake-wrappers

This is the development home of the Snakemake wrapper repository, see
https://snakemake-wrappers.readthedocs.io
215 stars 186 forks source link

feat: Varscan2 - SnpEff Meta wrapper #3501

Open tdayris opened 1 day ago

tdayris commented 1 day ago

I have been contacted about issue #275 . Varscan2 and SnpEff are compatible while calling somatic variants. No error is produced, and SNP are correctly annotated in the end.

QC

While the contributions guidelines are more extensive, please particularly ensure that:

Summary by CodeRabbit

coderabbitai[bot] commented 1 day ago
πŸ“ Walkthrough
πŸ“ Walkthrough ## Walkthrough The changes introduce a new meta-wrapper configuration for a bioinformatics pipeline in the `meta.yaml` file, detailing five steps for variant calling and annotation. A new `Snakefile` establishes rules for genome analysis workflows, integrating tools like Samtools and SnpEff. The `used_wrappers.yaml` file is updated to include a section listing relevant bioinformatics tools. Additionally, a new test function is added to `test_wrappers.py` to validate the integration of VarScan2 with SnpEff. These updates enhance the structure and testing of the bioinformatics pipeline. ## Changes | File | Change Summary | |-------------------------------------------|-------------------------------------------------------------------------------------------------| | `meta/bio/varscan2_snpeff/meta.yaml` | Added `description` and `authors` fields; outlined five key steps for variant calling/annotation. | | `meta/bio/varscan2_snpeff/test/Snakefile`| Introduced five rules: `get_genome_fasta`, `samtools_mpileup`, `varscan2_somatic`, `snpeff_download`, and `snpeff_annotate`. | | `meta/bio/varscan2_snpeff/used_wrappers.yaml` | Added a new `wrappers` section listing five bioinformatics tools. | | `test_wrappers.py` | Added a new test function `test_varscan2_snpeff_meta(run)` for testing the Snakemake command. | ## Possibly related PRs - **#3122**: Relates to the overall structure and organization of wrapper files, similar to updates in the meta-wrapper configuration. - **#3125**: Focuses on wrapper functionality, potentially connecting with the structured approach in the main PR's `meta.yaml`. - **#3135**: Introduces a feature related to Snakemake workflows, which may connect with workflow enhancements in the main PR. - **#3171**: Focuses on quality control in bioinformatics workflows, which could relate to the overall structure of the pipeline. - **#3305**: Relates to improvements in bioinformatics tools and workflows, similar to the changes made in the main PR. - **#3367**: Fixes to the gffread wrapper may connect with handling genomic annotations in the main PR. - **#3453**: Connects with the structured approach to bioinformatics tools in the main PR. - **#3496**: Directly related to the main PR's focus on improving the configuration and usability of bioinformatics tools. ## Suggested reviewers - fgvieira

[!WARNING]

Rate limit exceeded

@tdayris has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 25 minutes and 4 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](https://docs.coderabbit.ai/faq) for further information.
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 09f8971a707e2409db372efb02c16d80937f07ef and 55f485cc8db9c3bbbecd8dbefd5f3c19b641aa91.

πŸ“œ Recent review details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
πŸ“₯ Commits Reviewing files that changed from the base of the PR and between 09f8971a707e2409db372efb02c16d80937f07ef and 55f485cc8db9c3bbbecd8dbefd5f3c19b641aa91.
πŸ“’ Files selected for processing (1) * `test_wrappers.py` (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1) * test_wrappers.py

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
πŸͺ§ Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.