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

Add bam2plot #51975

Merged
merged 5 commits into from
Nov 7, 2024
Merged

Add bam2plot #51975

merged 5 commits into from
Nov 7, 2024

Conversation

druvus
Copy link
Member

@druvus druvus commented Nov 6, 2024

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 6, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request updates the meta.yaml file for the bam2plot package, version 0.3.6. This file specifies the package configuration, including its name, version, and a source URL for downloading from PyPI, along with a SHA256 checksum for integrity verification. The package is designated as architecture-independent and includes an entry point for the command-line interface. The requirements section outlines both host and runtime dependencies, specifying compatible versions of Python and various libraries such as pysam, seaborn, polars, mappy, pyfastx, pyarrow, and the newly added mosdepth. The test section includes commands to verify the installation of bam2plot, along with help commands for different functionalities. The about section provides metadata, including the project's homepage, a brief summary of its functionality, the license type (GPL-3.0-only), and a reference to the license file.

Possibly related PRs

Suggested labels

please review & merge

Suggested reviewers

  • mencian

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: 1

🧹 Outside diff range and nitpick comments (2)
recipes/bam2plot/meta.yaml (2)

21-32: Add version constraints for pyfastx and pyarrow.

While most dependencies have appropriate version constraints, pyfastx and pyarrow should also be pinned to ensure reproducible builds.

-    - pyfastx
-    - pyarrow
+    - pyfastx >=0.8.0
+    - pyarrow >=14.0.1

34-38: Consider adding more comprehensive tests.

While the current tests verify basic functionality, consider adding:

  1. Version check command (bam2plot --version)
  2. Basic functionality test with a small BAM file

Would you like me to propose additional test commands or help create a test dataset?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between cdabb8c and b44604d.

📒 Files selected for processing (1)
  • recipes/bam2plot/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/bam2plot/meta.yaml

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (3)
recipes/bam2plot/meta.yaml (3)

1-6: LGTM! Package metadata follows best practices.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


40-44: LGTM! About section is complete and follows standards.


8-10: Verify PyPI package availability and checksum.

Comment on lines 18 to 19
run_exports:
- {{ pin_subpackage('pydeseq2', max_pin="x.x") }}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Remove incorrect run_exports section.

The run_exports section references pydeseq2 which is not listed in the requirements and doesn't appear to be a dependency of this package based on its functionality description.

-  run_exports:
-    - {{ pin_subpackage('pydeseq2', max_pin="x.x") }}
📝 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
run_exports:
- {{ pin_subpackage('pydeseq2', max_pin="x.x") }}

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: 2

🧹 Outside diff range and nitpick comments (3)
recipes/bam2plot/meta.yaml (3)

31-32: Add version constraints for pyfastx and pyarrow.

For better reproducibility and to prevent potential compatibility issues, consider adding minimum version constraints for these packages.

-    - pyfastx
-    - pyarrow
+    - pyfastx >=0.8.0
+    - pyarrow >=14.0.1

34-38: Consider adding more comprehensive tests.

While the basic smoke tests are good, consider adding tests for common subcommands or functionality checks.

Would you like me to suggest additional test commands based on the package's functionality?


41-42: Enhance the package summary.

The current summary "Plot of coverage from bam file" is quite brief. Consider expanding it to better describe the tool's features and use cases.

-  summary: Plot of coverage from bam file
+  summary: A tool for generating coverage plots from BAM files with support for various visualization options and customizations
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between b44604d and 60c398f.

📒 Files selected for processing (1)
  • recipes/bam2plot/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/bam2plot/meta.yaml

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (1)
recipes/bam2plot/meta.yaml (1)

1-6: LGTM! Package metadata is well-structured.

The package name and version are properly defined using Jinja2 variables.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

Comment on lines +18 to +19
run_exports:
- {{ pin_subpackage('bam2plot', max_pin="x.x") }}
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

Remove unnecessary run_exports section.

The run_exports section is not needed for Python packages as they don't have ABI compatibility concerns like C/C++ packages do.

-  run_exports:
-    - {{ pin_subpackage('bam2plot', max_pin="x.x") }}
📝 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
run_exports:
- {{ pin_subpackage('bam2plot', max_pin="x.x") }}

Comment on lines +8 to +10
source:
url: https://pypi.org/packages/source/{{ name[0] }}/{{ name }}/bam2plot-{{ version }}.tar.gz
sha256: 7be991b42db59d0c06ca2f354f906238be3c4f4d0588d85dd1cfd1ec7752a541
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

SHA256 checksum mismatch detected

The SHA256 checksum in the recipe (7be991b42db59d0c06ca2f354f906238be3c4f4d0588d85dd1cfd1ec7752a541) does not match the official PyPI package checksum (19e6c72cd31318c43f511c926090136b748923151ff0c37a9da782ea4dc1359e).

  • Update the sha256 value in meta.yaml to: 19e6c72cd31318c43f511c926090136b748923151ff0c37a9da782ea4dc1359e
🔗 Analysis chain

Verify the source package integrity.

The URL and checksum format are correct, but let's verify the SHA256 checksum matches the PyPI package.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the SHA256 checksum of the PyPI package
# Expected: The checksum should match "7be991b42db59d0c06ca2f354f906238be3c4f4d0588d85dd1cfd1ec7752a541"

curl -sL "https://pypi.org/packages/source/b/bam2plot/bam2plot-0.3.6.tar.gz" | sha256sum

Length of output: 165


Script:

#!/bin/bash
# Let's try a different approach using Python's pip to get package info
curl -sL "https://pypi.org/pypi/bam2plot/json" | jq -r '.releases."0.3.6"[0].digests.sha256'

Length of output: 157

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: 0

🧹 Outside diff range and nitpick comments (1)
recipes/bam2plot/meta.yaml (1)

44-48: Consider enhancing the package summary.

While the current summary is accurate, it could be more descriptive. Consider adding details about:

  • The types of plots it generates
  • The specific use cases it addresses
  • Any unique features or capabilities
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 60c398f and 4029b48.

📒 Files selected for processing (1)
  • recipes/bam2plot/meta.yaml (1 hunks)
🧰 Additional context used
🪛 yamllint
recipes/bam2plot/meta.yaml

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)

🔇 Additional comments (5)
recipes/bam2plot/meta.yaml (5)

1-6: LGTM! Package metadata is well-defined.

🧰 Tools
🪛 yamllint

[error] 1-1: syntax error: found character '%' that cannot start any token

(syntax)


8-10: Skipping comment about SHA256 mismatch as it's already covered in previous review.


12-17: LGTM! Build configuration follows best practices.


36-42: LGTM! Comprehensive test coverage.

Good test coverage including both package import and CLI functionality verification.


21-34: Consider adding version constraints for all dependencies.

Some dependencies lack version constraints which could lead to compatibility issues:

  • pyfastx
  • pyarrow
  • mosdepth

Let's verify if mosdepth is available in bioconda:

@druvus
Copy link
Member Author

druvus commented Nov 6, 2024

@BiocondaBot please fetch artifacts

@BiocondaBot
Copy link
Collaborator

Package(s) built are ready for inspection:

Arch Package Zip File / Repodata CI Instructions
noarch bam2plot-0.3.6-pyhdfd78af_0.tar.bz2 noarch.zip GitHub Actions
showYou may also use conda to install after downloading and extracting the zip file. conda install -c ./packages <package name>

@druvus
Copy link
Member Author

druvus commented Nov 6, 2024

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Nov 6, 2024
@bgruening bgruening merged commit 498c2ee into bioconda:master Nov 7, 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.

3 participants