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

Update pdivas recipe #52089

Merged
merged 8 commits into from
Nov 21, 2024
Merged

Conversation

shiro-kur
Copy link
Contributor

Describe your pull request here


Please read the guidelines for Bioconda recipes before opening a pull request (PR).

General instructions

  • If this PR adds or updates a recipe, use "Add" or "Update" appropriately as the first word in its title.
  • New recipes not directly relevant to the biological sciences need to be submitted to the conda-forge channel instead of Bioconda.
  • PRs require reviews prior to being merged. Once your PR is passing tests and ready to be merged, please issue the @BiocondaBot please add label command.
  • Please post questions on Gitter or ping @bioconda/core in a comment.

Instructions for avoiding API, ABI, and CLI breakage issues

Conda is able to record and lock (a.k.a. pin) dependency versions used at build time of other recipes.
This way, one can avoid that expectations of a downstream recipe with regards to API, ABI, or CLI are violated by later changes in the recipe.
If not already present in the meta.yaml, make sure to specify run_exports (see here for the rationale and comprehensive explanation).
Add a run_exports section like this:

build:
  run_exports:
    - ...

with ... being one of:

Case run_exports statement
semantic versioning {{ pin_subpackage("myrecipe", max_pin="x") }}
semantic versioning (0.x.x) {{ pin_subpackage("myrecipe", max_pin="x.x") }}
known breakage in minor versions {{ pin_subpackage("myrecipe", max_pin="x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
known breakage in patch versions {{ pin_subpackage("myrecipe", max_pin="x.x.x") }} (in such a case, please add a note that shortly mentions your evidence for that)
calendar versioning {{ pin_subpackage("myrecipe", max_pin=None) }}

while replacing "myrecipe" with either name if a name|lower variable is defined in your recipe or with the lowercase name of the package in quotes.

Bot commands for PR management

Please use the following BiocondaBot commands:

Everyone has access to the following BiocondaBot commands, which can be given in a comment:

@BiocondaBot please update Merge the master branch into a PR.
@BiocondaBot please add label Add the please review & merge label.
@BiocondaBot please fetch artifacts Post links to CI-built packages/containers.
You can use this to test packages locally.

Note that the @BiocondaBot please merge command is now depreciated. Please just squash and merge instead.

Also, the bot watches for comments from non-members that include @bioconda/<team> and will automatically re-post them to notify the addressed <team>.

Copy link
Contributor

coderabbitai bot commented Nov 13, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

This pull request introduces two main changes to the pdivas package. First, a new LICENSE file has been added to the recipes/pdivas directory, containing the text of the MIT License. This license allows users to use, copy, modify, and distribute the software, provided that the copyright notice and permission notice are included. It also includes a disclaimer that the software is provided "as is," without any warranty.

Second, the meta.yaml file for the pdivas package has undergone several updates. The version number has been incremented from 1.1.0 to 1.2.0, and the SHA256 checksum has been modified to match the new package version. The requirements section has been revised to specify minimum versions for pandas, numpy, and cyvcf2, while scikit-learn is now pinned to version 1.0.2. Additionally, a new run_exports field has been added, the home URL has been reformatted, and the maintainer entry has been updated.

Possibly related PRs

Suggested reviewers

  • mencian
  • adamhospital

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.

Copy link
Contributor

@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: 3

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 80a6ddc and c9340e6.

📒 Files selected for processing (2)
  • recipes/pdivas/LICENSE (1 hunks)
  • recipes/pdivas/meta.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • recipes/pdivas/LICENSE
🔇 Additional comments (4)
recipes/pdivas/meta.yaml (4)

15-19: LGTM! Good addition of run_exports

The addition of run_exports with exact pinning is a good practice for ensuring API stability, which aligns with the project guidelines.


36-39: LGTM! Good test coverage

The addition of pip check helps verify dependency compatibility, and the test configuration properly validates both imports and CLI functionality.


27-30: Verify dependency version constraints

Please verify:

  1. Are the minimum version requirements for pandas, numpy, and cyvcf2 aligned with the package's needs?
  2. Why is scikit-learn pinned to exactly 1.0.2? This strict pinning might cause dependency conflicts.
#!/bin/bash
# Check for potential dependency conflicts
gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: PIP, package: "scikit-learn", package: "1.0.2") {
    nodes {
      advisory {
        summary
        severity
      }
    }
  }
}'

2-6: Verify version consistency

The version has been bumped to 1.2.0, which matches the source URL. However, let's verify this is the latest version available.

✅ Verification successful

Build configuration is correct.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if 1.2.0 is the latest version on PyPI
curl -s https://pypi.org/pypi/pdivas/json | jq -r '.info.version'

Length of output: 497


Script:

#!/bin/bash
# Fetch the latest version of pdivas from PyPI
curl -s https://pypi.org/pypi/pdivas/json | jq -r '.info.version'

# Verify if the fetched version matches 1.2.0
fetched_version=$(curl -s https://pypi.org/pypi/pdivas/json | jq -r '.info.version')
expected_version="1.2.0"

if [ "$fetched_version" == "$expected_version" ]; then
  echo "Version is up-to-date."
else
  echo "Version mismatch: Expected $expected_version, but found $fetched_version."
fi

Length of output: 268


Script:

#!/bin/bash
# Extract the source URL from meta.yaml
source_url=$(grep '^  url:' recipes/pdivas/meta.yaml | awk '{print $2}' | tr -d '"')

# Extract the expected version
expected_version="1.2.0"

# Check if the version is present in the source URL
if echo "$source_url" | grep -q "$expected_version"; then
  echo "Source URL is consistent with version $expected_version."
else
  echo "Source URL does not match the expected version $expected_version."
fi

Length of output: 489


Script:

#!/bin/bash
# Extract the build section from meta.yaml
build_section=$(awk '/^build:/,/^requirements:/ {print}' recipes/pdivas/meta.yaml)

# Display the build section
echo "$build_section"

# Check for build number (assuming build number is specified)
build_number=$(echo "$build_section" | grep 'number:' | awk '{print $2}')
if [ -z "$build_number" ]; then
  echo "No build number specified."
else
  echo "Build number: $build_number"
  # Optionally, verify if build number follows expected increment
  # This requires knowledge of the previous build number
fi

# Check for build dependencies
build_dependencies=$(echo "$build_section" | grep 'run:' | awk '{print $2}')
if [ -z "$build_dependencies" ]; then
  echo "No build dependencies specified."
else
  echo "Build dependencies: $build_dependencies"
fi

Length of output: 1439


Script:

#!/bin/bash
# Retrieve the build number from the previous version of meta.yaml

# Get the previous commit that modified meta.yaml
previous_commit=$(git log -2 --pretty=format:"%H" recipes/pdivas/meta.yaml | tail -n1)

if [ -z "$previous_commit" ]; then
  echo "No previous commit found for meta.yaml."
  exit 1
fi

# Extract the build number from the previous meta.yaml
previous_build_number=$(git show $previous_commit:recipes/pdivas/meta.yaml | grep '^  number:' | awk '{print $2}')

if [ -z "$previous_build_number" ]; then
  echo "No build number found in the previous meta.yaml."
else
  echo "Previous build number: $previous_build_number"
fi

Length of output: 401

Comment on lines 9 to 10
url: https://files.pythonhosted.org/packages/fc/7e/281e2053ea00eae24162211af598c247d3c5e4fb2c0d043e24c2e19897e6/pdivas-1.2.0.tar.gz
sha256: 4a2234564557622c5bd2213478956c4a4858ba6768251d24ee43a4fc7550f721
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Use templated PyPI URL for better maintainability

The direct PyPI URL should be replaced with the templated version for better maintainability.

-  url: https://files.pythonhosted.org/packages/fc/7e/281e2053ea00eae24162211af598c247d3c5e4fb2c0d043e24c2e19897e6/pdivas-1.2.0.tar.gz
+  url: "https://pypi.io/packages/source/{{ name[0] }}/{{ name }}/{{ name }}-{{ version }}.tar.gz"
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
url: https://files.pythonhosted.org/packages/fc/7e/281e2053ea00eae24162211af598c247d3c5e4fb2c0d043e24c2e19897e6/pdivas-1.2.0.tar.gz
sha256: 4a2234564557622c5bd2213478956c4a4858ba6768251d24ee43a4fc7550f721
url: "https://pypi.io/packages/source/{{ name[0] }}/{{ name }}/{{ name }}-{{ version }}.tar.gz"
sha256: 4a2234564557622c5bd2213478956c4a4858ba6768251d24ee43a4fc7550f721

@shiro-kur
Copy link
Contributor Author

@BiocondaBot please add label

I updated the recipe to work.

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Nov 14, 2024

source:
url: "https://pypi.io/packages/source/{{ name[0] }}/{{ name }}/{{ name }}-{{ version }}.tar.gz"
sha256: ca33dc31ecfa9c505105a25146ea8efcdddb1a13cc1ac990c29561cc911d74b9
url: https://files.pythonhosted.org/packages/fc/7e/281e2053ea00eae24162211af598c247d3c5e4fb2c0d043e24c2e19897e6/pdivas-1.2.0.tar.gz
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you use the old URL-template?

@bioconda bioconda deleted a comment from coderabbitai bot Nov 16, 2024

extra:
recipe-maintainers:
- shiro-kur
- AddYourGitHubIdHere
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not look correct?

@bioconda bioconda deleted a comment from coderabbitai bot Nov 16, 2024
license_family: OTHER
home: http://github.com/account/repository
summary: 'PDIVAS: Pathogenicity predictor of Deep-Intronic Variants causing Aberrant Splicing'
license: 'MIT'
license_file:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
license_file:
license_file: LICENSE

Copy link
Member

@bgruening bgruening left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @shiro-kur

@bgruening bgruening merged commit a35bede into bioconda:master Nov 21, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
please review & merge set to ask for merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants