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

chore: update hgnc_complete_set download url #100

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tedil
Copy link

@tedil tedil commented Dec 11, 2024

Summary by CodeRabbit

  • New Features

    • Updated URLs for genomic data sources, including the HGNC complete set now hosted on Google Cloud Storage.
    • Added multiple new URLs related to the gnomAD project, including various VCF files for different chromosomes and versions.
  • Bug Fixes

    • Removed outdated URLs pointing to OrphaData API endpoints and other genomic data sources.
  • Chores

    • Marked some URLs with skip_upstream_check: true for reliability during tests.

Copy link

coderabbitai bot commented Dec 11, 2024

Walkthrough

The changes involve updates to the download_urls.yml file and the Snakemake workflow in rules/work/genes/hgnc.smk. The download_urls.yml file underwent modifications to URLs, including the removal of several endpoints and the addition of new genomic data sources. Notably, the URL for the HGNC complete set JSON file was changed from an FTP link to a Google Cloud Storage link. In the Snakemake workflow, the genes_hgnc_download rule was updated to reflect this new URL, while other rules remained unchanged.

Changes

File Path Change Summary
download_urls.yml Updated URLs, removed several endpoints, added new genomic data URLs, modified excerpt strategies.
rules/work/genes/hgnc.smk Updated HGNC JSON download URL in genes_hgnc_download rule; no changes to other rules.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Snakemake
    participant HGNC

    User->>Snakemake: Request HGNC data
    Snakemake->>HGNC: Download JSON from new URL
    HGNC-->>Snakemake: Return JSON data
    Snakemake-->>User: Provide processed data
Loading

🐰 In fields so wide and bright,
URLs changed, a joyful sight!
From FTP to clouds we leap,
New data sources, promises to keep.
With every hop, our knowledge grows,
In genomic tales, the rabbit knows! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7557523 and 61706be.

📒 Files selected for processing (2)
  • download_urls.yml (1 hunks)
  • rules/work/genes/hgnc.smk (1 hunks)
🔇 Additional comments (2)
rules/work/genes/hgnc.smk (1)

17-17: Verify the URL path structure

The new URL contains a redundant "json/json/" path segment which may be a typo. Please verify if this is the correct path structure.

Run the following script to verify the URL accessibility and correct path:

✅ Verification successful

URL path structure is correct and accessible

The current URL with "json/json/" in the path is correct and accessible, returning a 200 status code with a valid JSON file (33MB). The alternative URL without the redundant "json" returns a 404 error. The file was last modified on December 6, 2024, indicating it's actively maintained.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check URL accessibility and compare with potential alternatives

# Test the current URL
echo "Testing current URL..."
curl -sI "https://storage.googleapis.com/public-download-files/hgnc/json/json/hgnc_complete_set.json"

# Test without redundant json/
echo -e "\nTesting alternative URL..."
curl -sI "https://storage.googleapis.com/public-download-files/hgnc/json/hgnc_complete_set.json"

Length of output: 1314

download_urls.yml (1)

254-257: LGTM! Configuration is properly structured

The new URL entry is well-configured with appropriate flags:

  • skip_upstream_check is set due to potential reliability issues
  • Manual excerpt strategy is consistent with other similar entries

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. (Experiment)
  • @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

Please check for formatting and linting issues. You can use make lint to:

  • Check your Bash style with beautysh and formatting with shellcheck.
  • Check your Python style with black, linting with flake8.
  • Check your Snakemake style with snakefmt.

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