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 orthofinder for 3.0.1b1 beta release #51202

Merged
merged 2 commits into from
Oct 7, 2024
Merged

Update orthofinder for 3.0.1b1 beta release #51202

merged 2 commits into from
Oct 7, 2024

Conversation

davidemms
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>.

@davidemms davidemms requested a review from TomHarrop October 7, 2024 11:37
Copy link
Contributor

coderabbitai bot commented Oct 7, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces significant modifications to the Orthofinder installation process through two main files: build.sh and meta.yaml. In build.sh, two new Python scripts, create_files_for_hogs.py and orthogroup_gene_count.py, have been added to the $PREFIX/bin directory, and executable permissions are set for these and existing files. Additionally, a new directory $PREFIX/share/orthofinder/ is created, containing the ExampleData directory. The script also retains a sed command to update the config.json file. In meta.yaml, the version of the Orthofinder package is updated from 2.5.5 to 3.0.1b1, with a corresponding SHA256 checksum change and a reset of the build number. The Python version constraint is tightened, and new dependencies, including scikit-learn, biopython, and aster, are introduced. A new files section is also added to list ExampleData as an included file.

Possibly related PRs

Suggested labels

new version

Suggested reviewers

  • berkelem

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 113c2b0 and 3e5bf03.

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

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

(syntax)

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

10-12: Build number reset and run_exports addition look good.

The build number has been correctly reset to 0 for the new version. The run_exports section has been added as suggested in a previous review, which will help ensure compatibility with downstream recipes.


1-1: Ignore yamllint syntax error for '%' character.

The static analysis tool yamllint reports a syntax error for the '%' character at the beginning of the file. This is a false positive as the '%' is part of the Jinja2 templating syntax commonly used in Conda recipes. No action is required.

🧰 Tools
🪛 yamllint

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

(syntax)


Line range hint 20-37: Python constraint update and new dependencies look good, but verify scikit-learn necessity.

The Python version constraint has been appropriately tightened to >=3.7,<3.12, which helps ensure compatibility. The new dependencies (scikit-learn, biopython, and aster) have been added, likely reflecting the requirements for the new version of Orthofinder.

However, the addition of scikit-learn might significantly increase the package size. Please verify if it's absolutely necessary for the core functionality of Orthofinder. If it's only used for optional features, consider making it an optional dependency.

You can check the impact on package size with:

#!/bin/bash
# Check the size impact of scikit-learn
conda create -n test_env python=3.8 scikit-learn -y
conda list -n test_env --explicit | grep scikit-learn
conda env remove -n test_env -y

49-50: Addition of ExampleData looks good, but verify size impact.

The new files section with ExampleData has been added, which aligns with the changes mentioned in the AI summary. This is likely beneficial for users to have example data readily available.

However, please verify the size impact of including this data in the package. If it's large, consider providing it as a separate download or as an optional component. You can check the size with:


1-2: Version and checksum update looks good.

The version has been correctly updated to 3.0.1b1, and the SHA256 checksum has been updated accordingly. This aligns with the PR objective to update Orthofinder to the latest beta release.

Note that this is a beta version, which may introduce instability. Consider adding a note in the package description to inform users about the beta status. You can verify the version and checksum with:

🧰 Tools
🪛 yamllint

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

(syntax)


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

🧹 Outside diff range and nitpick comments (5)
recipes/orthofinder/build.sh (2)

27-28: LGTM: Example data correctly added

The creation of a new directory for example data and copying the ExampleData into it is a good practice. This separates example data from executable files and aligns with the PR objectives.

Consider adding a comment explaining the purpose of this new directory, e.g.:

+# Create directory for example data
mkdir -p $PREFIX/share/orthofinder/
+# Copy example data for user reference
cp -r ExampleData $PREFIX/share/orthofinder/

Missing Required Files Detected in build.sh

The verification script indicates that the following required files and directories are missing:

  • orthofinder.py
  • scripts_of/config.json
  • tools/convert_orthoginder_tree_ids.py
  • tools/create_files_for_hogs.py
  • tools/make_ultrametric.py
  • tools/orthogroup_gene_count.py
  • tools/primary_transcript.py
  • ExampleData

Please ensure that these files are present in the repository and that the build.sh script correctly references their paths.

🔗 Analysis chain

Line range hint 1-28: Summary: Build script successfully updated for Orthofinder 3.0.1b1

The changes to the build script align well with the PR objectives of updating Orthofinder to version 3.0.1b1. Key improvements include:

  1. Addition of new Python scripts (create_files_for_hogs.py and orthogroup_gene_count.py).
  2. Proper setting of executable permissions for new scripts.
  3. Creation of a separate directory for example data.

These changes enhance the functionality and organization of the Orthofinder package, making it consistent with the beta release 3.0.1b1.

To ensure all necessary files are included, please run the following verification script:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify all expected files are present in the recipe

# Test: Check if all mentioned scripts and directories exist
echo "Checking for required files and directories:"
required_files=(
  "orthofinder.py"
  "scripts_of/config.json"
  "tools/convert_orthofinder_tree_ids.py"
  "tools/create_files_for_hogs.py"
  "tools/make_ultrametric.py"
  "tools/orthogroup_gene_count.py"
  "tools/primary_transcript.py"
  "ExampleData"
)

for file in "${required_files[@]}"; do
  if [ -e "$file" ]; then
    echo "$file exists"
  else
    echo "$file is missing"
  fi
done

Length of output: 1629

recipes/orthofinder/meta.yaml (3)

1-2: Highlight beta release status

The version has been updated to 3.0.1b1, which is a beta release. This aligns with the PR objective, but it's important to note that beta releases may have stability issues.

Consider adding a comment in the package metadata or description to clearly indicate that this is a beta release. This will help users make an informed decision about using this version in their environments.

🧰 Tools
🪛 yamllint

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

(syntax)


33-35: New dependencies added

The addition of scikit-learn, biopython, and aster as new dependencies is noted. These likely support new features in the updated version.

Consider specifying version constraints for these new dependencies to ensure compatibility and reproducibility. For example:

- scikit-learn >=0.24
- biopython >=1.79
- aster >=1.0

Replace the version numbers with those that are known to work with this version of OrthoFinder.


47-48: ExampleData added to files section

The addition of ExampleData to the files section is noted and approved. This ensures that example data is included with the package, which can be helpful for users.

Consider providing more details about the ExampleData, such as its location within the package structure or a brief description of its contents. This will help users understand what example data is available and how to access it.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7f3c9f8 and 113c2b0.

📒 Files selected for processing (2)
  • recipes/orthofinder/build.sh (1 hunks)
  • recipes/orthofinder/meta.yaml (3 hunks)
🧰 Additional context used
🪛 yamllint
recipes/orthofinder/meta.yaml

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

(syntax)

🔇 Additional comments (5)
recipes/orthofinder/build.sh (3)

15-17: LGTM: New scripts added correctly

The addition of create_files_for_hogs.py and orthogroup_gene_count.py to the $PREFIX/bin directory is correct and aligns with the PR objectives. These new scripts will enhance the functionality of Orthofinder.


22-25: LGTM: Correct permissions set for new scripts

The addition of chmod commands to make the new scripts executable is correct and necessary. This ensures that users will be able to run the newly added scripts without permission issues.


26-26: LGTM: Improved readability

The addition of an empty line improves the script's readability by clearly separating different sections.

recipes/orthofinder/meta.yaml (2)

10-10: Build number reset approved

Resetting the build number to 0 for the new version is correct and follows Conda packaging best practices.


18-18: Verify Python version constraint

The Python version constraint has been tightened to >=3.7,<3.12. This change is generally good as it prevents potential issues with untested Python versions.

Please confirm that the upper bound (<3.12) is intentional and aligns with the package's known compatibility. You can verify this by checking the package's documentation or running the following command to search for any mentions of Python version compatibility:

@davidemms
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Oct 7, 2024
@martin-g martin-g merged commit 106a368 into master Oct 7, 2024
7 checks passed
@martin-g martin-g deleted the orthofinder_v3 branch October 7, 2024 13:17
This was referenced Nov 1, 2024
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