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: complete minimal workflow as template #8

Closed
wants to merge 2 commits into from

Conversation

m-jahn
Copy link

@m-jahn m-jahn commented Nov 29, 2024

  • added wf with 5 modules
  • complete process of reading reads to processing to QC
  • no local data; test data is generated on the fly

Summary by CodeRabbit

  • New Features

    • Introduced new configuration files for managing genomic data processing and analysis.
    • Added multiple rules for processing genomic data, including fetching genomes, simulating reads, and generating quality reports.
    • Implemented a script for downloading and validating genome sequences and annotations from NCBI.
  • Documentation

    • Updated README with detailed usage instructions and a structured table of contents.
  • Chores

    • Enhanced GitHub Actions workflows for improved pull request validation and environment management.

Copy link

coderabbitai bot commented Nov 29, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request includes significant updates across multiple workflow files and configurations. Key changes involve renaming workflow components, enhancing pull request validation processes, and introducing new configuration files for genomic data processing. The .gitignore file has been updated, and several new Conda environment configurations have been added for tools like Cutadapt and FastQC. Additionally, a new Snakefile structure has been established to facilitate genomic data processing, featuring rules for genome retrieval, read simulation, quality control, and reporting.

Changes

File Change Summary
.github/workflows/conventional-prs.yml Workflow name changed to "Lint PR", job renamed to "main", new step "Validate PR title" added, action version updated to v5, and permissions added for pull requests.
.github/workflows/main.yml Branch triggers updated to include dev, added conditions to prevent execution by the github-actions[bot], upgraded actions/checkout to v4, and updated snakemake action versions.
.github/workflows/release-please.yml Minor formatting change with no functional impact.
.gitignore Added entry to ignore .test/results/*.
.test/config/config.yml New configuration file added for genomic data processing with multiple sections for parameters and settings.
.test/config/multiqc_config.yml Added remove_sections key to exclude samtools-stats from reports.
README.md Updated Snakemake version requirement, modified GitHub Actions badge, added new badges, structured table of contents, and expanded sections for clarity.
config/config.yml New configuration file added with settings for genomic analysis and read simulation.
config/multiqc_config.yml Added remove_sections configuration option.
config/schemas/config.schema.yml New JSON schema added for validating sample sheet entries with defined properties.
config/schemas/samples.schema.yml New JSON schema added for sample sheet structure with required properties.
workflow/Snakefile Added configuration loading, user feedback mechanisms, and minor formatting adjustments.
workflow/envs/cutadapt.yml New Conda environment configuration for Cutadapt tool.
workflow/envs/fastqc.yml New Conda environment configuration for FastQC tool.
workflow/envs/get_genome.yml New Conda environment configuration for genomic data processing tools.
workflow/envs/multiqc.yml New Conda environment configuration for MultiQC tool.
workflow/envs/simulate_reads.yml New Conda environment configuration for read simulation.
workflow/rules/common.smk New file for reading and validating sample sheets and configuration files.
workflow/rules/process_reads.smk New workflow file defining rules for genomic data processing including genome retrieval and quality control.
workflow/scripts/get_genome.py New script for downloading and validating genome sequence and annotation files from NCBI.

Poem

🐰 In the meadow where changes bloom,
New workflows dance, dispelling gloom.
With genomic tools, we hop and play,
Validating paths, come what may!
From samples to reports, we’ll find our way,
In this rabbit's world, it’s a bright new day! 🌼


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.

@m-jahn m-jahn closed this Nov 29, 2024
@m-jahn
Copy link
Author

m-jahn commented Nov 29, 2024

sorry, this was opened on the wrong repo!
My apologies.

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