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 phenograph package #51795

Closed
wants to merge 2 commits into from
Closed

Conversation

LeonHafner
Copy link
Contributor

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 Oct 29, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

A new metadata file named meta.yaml has been introduced for the PhenoGraph package, specifying its name as "PhenoGraph" and version as "1.5.7". The file includes a source section with the URL for downloading the package from PyPI and its SHA256 checksum for integrity verification. The build section indicates that the package is architecture-independent and provides the command to install it using pip with specific options. The run_exports section includes a pinned dependency for the subpackage "phenograph". The requirements section details the dependencies for both host and runtime environments, specifying Python version requirements and libraries such as leidenalg, setuptools, numpy, scipy, scikit-learn, and psutil, along with their version constraints. Additionally, the test section includes an import statement for testing, while the about section provides metadata including the package's homepage, summary, license, and development URL. Lastly, the extra section lists the recipe maintainers.

Possibly related PRs

  • recipe for pgrc #50973: The introduction of a meta.yaml file for the pgrc package, defining package metadata, dependencies, and build instructions.
  • Add patchify #51268: The meta.yaml file for the patchify package introduces a new package configuration, focusing on package metadata and dependencies.
  • Add gene-trajectory-python recipe #51476: The gene-trajectory-python package's meta.yaml file introduces a new package configuration, defining package metadata and dependencies.
  • Add svtopovz python package #51643: The svtopovz package's meta.yaml file introduces a new package configuration, detailing package metadata and dependencies.

Suggested labels

please review & merge

Suggested reviewers

  • martin-g

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

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

32-34: Consider adding more comprehensive tests.

While the basic import test is good, consider adding:

  • Command-line interface tests if any exist
  • Basic functionality tests to ensure the package works as expected

Would you like help generating additional test cases?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ba3cde9 and af48904.

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

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

(syntax)

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

1-6: LGTM! Package metadata is properly configured.

🧰 Tools
🪛 yamllint

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

(syntax)


44-46: LGTM! Maintainer information is correctly specified.


12-17: Consider if run_exports is necessary for this pure Python package.

The run_exports section is typically used for compiled extensions where ABI compatibility matters. Since PhenoGraph appears to be a pure Python package, this section might not be necessary.

#!/bin/bash
# Description: Check if package has compiled extensions
# Expected: No setup.py with extension modules

# Look for potential C extensions in setup.py
rg -l "Extension|setup.*\(.*ext_modules" 

37-38: Verify package's relevance to biological sciences.

The package summary mentions "single-cell data", suggesting biological relevance. However, let's verify its primary use case to ensure it belongs in Bioconda rather than conda-forge.

✅ Verification successful

Package confirmed as biologically relevant - suitable for Bioconda

The verification results strongly confirm this package's biological relevance:

  • Published in Cell journal (a premier biological sciences journal)
  • Specifically designed for single-cell data analysis
  • Used for phenotypic analysis of AML (Acute Myeloid Leukemia)
  • Developed by dpeerlab (Dana Pe'er's lab, known for computational biology research)
  • Focuses on biological phenotype detection and cell population analysis
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check package's biological relevance
# Expected: Find references to biological/single-cell analysis

# Check PyPI description for biological terms
curl -s "https://pypi.org/pypi/PhenoGraph/1.5.7/json" | jq -r '.info.description' | grep -iE "cell|rna|gene|bio|sequence|protein"

# Check GitHub repository description and topics
curl -s "https://api.github.com/repos/dpeerlab/PhenoGraph" | jq -r '.description, .topics[]'

Length of output: 923


36-42: Verify LICENSE file existence in the source package.

The recipe references a LICENSE file, but we should verify it exists in the source package.

✅ Verification successful

Let me try a different approach to verify the LICENSE file existence.


LICENSE file is present and correctly referenced

The LICENSE file exists in the repository root and contains the MIT license text, which matches the license metadata specified in the recipe. The license_file field in the recipe correctly references this file.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if LICENSE file exists in the package
# Expected: Find LICENSE file in package contents

curl -sL "https://pypi.org/pypi/PhenoGraph/1.5.7/json" | jq -r '.urls[0].filename' | xargs -I{} curl -sL "https://pypi.org/packages/source/p/phenograph/{}" | tar -tz | grep -i license

Length of output: 923


Script:

#!/bin/bash
# Try to fetch the LICENSE file directly from the GitHub repository
curl -sL "https://raw.githubusercontent.com/dpeerlab/PhenoGraph/master/LICENSE"

# Also check if there are any other license files in the repository
gh api repos/dpeerlab/PhenoGraph/contents | jq -r '.[].name' | grep -i license

Length of output: 1244

recipes/phenograph/meta.yaml Outdated Show resolved Hide resolved
recipes/phenograph/meta.yaml Outdated Show resolved Hide resolved
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/phenograph/meta.yaml (1)

32-34: Consider enhancing test coverage.

The current test only verifies basic import. Consider adding:

  • Additional module imports
  • Command-line interface tests if available
  • Basic functionality tests

Would you like me to help generate additional test cases based on the package documentation?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between af48904 and c65308f.

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

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

(syntax)

🔇 Additional comments (6)
recipes/phenograph/meta.yaml (6)

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

The package name and version are properly defined using Jinja2 variables, with correct lowercasing of the package name.

🧰 Tools
🪛 yamllint

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

(syntax)


44-46: LGTM: Maintainer section is properly configured.

The recipe maintainer is correctly specified.


8-10: Verify source URL and checksum.

The URL format is correct, but let's verify the accessibility and checksum.

#!/bin/bash
# Description: Verify package URL accessibility and checksum
# Expected: URL should be accessible and checksum should match

# Verify URL accessibility
curl -sI "https://files.pythonhosted.org/packages/75/97/c1077df94cb0e1ebd201d67e52c438810fdaa393dc4c663b3bc651e497b8/PhenoGraph-1.5.7.tar.gz" | head -n1

# Download and verify checksum
curl -sL "https://files.pythonhosted.org/packages/75/97/c1077df94cb0e1ebd201d67e52c438810fdaa393dc4c663b3bc651e497b8/PhenoGraph-1.5.7.tar.gz" | sha256sum

12-17: Verify run_exports configuration.

The build configuration looks good, but the run_exports section needs attention:

  1. Ensure the pinning strategy aligns with the package's versioning scheme.
  2. Verify if the package actually provides any shared libraries that need pinning.
#!/bin/bash
# Description: Check if package contains shared libraries
# Expected: Should show any .so files if present

# Search for setup.py to check for extensions
fd -t f "setup.py" | xargs rg -l "Extension|setup.*ext_modules"

19-30: Verify dependency versions against PyPI metadata.

The requirements look well-structured, but let's verify the version constraints against the package's actual requirements.

#!/bin/bash
# Description: Verify dependency versions against PyPI metadata
# Expected: Version constraints should match package requirements

# Get package metadata from PyPI
curl -s "https://pypi.org/pypi/phenograph/1.5.7/json" | jq -r '.info.requires_dist[]'

36-42: Verify license file and URLs.

The about section is well-documented. Let's verify:

  1. License file existence in the source package
  2. URL accessibility

@LeonHafner
Copy link
Contributor Author

@BiocondaBot please fetch artifacts

@BiocondaBot
Copy link
Collaborator

No artifacts found on the most recent builds. Either the builds failed, the artifacts have been removed due to age, or the recipe was blacklisted/skipped.

@LeonHafner LeonHafner closed this Oct 29, 2024
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.

2 participants