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 r-phylopath #50994

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add r-phylopath #50994

wants to merge 2 commits into from

Conversation

apcamargo
Copy link
Contributor

@apcamargo apcamargo commented Sep 26, 2024

This PR adds the r-phylopath R library.


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

Summary by CodeRabbit

  • New Features

    • Introduced a new shell script to streamline the installation process for R packages.
    • Added a package configuration file for r-phylopath, version 1.3.0, detailing dependencies and integrity verification.
  • Documentation

    • Included metadata about the package, such as its homepage, summary, and licensing information.

Copy link

coderabbitai bot commented Sep 26, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces two new files for the r-phylopath package. The build.sh script sets an environment variable to disable Homebrew during the build process and installs the R package using specified arguments. The meta.yaml file outlines the package configuration, including its version, source URL, SHA256 checksum, dependencies, and testing commands, along with metadata about the package.

Changes

File(s) Change Summary
recipes/r-phylopath/build.sh, recipes/r-phylopath/meta.yaml Introduced build.sh for controlled R package installation and meta.yaml for package configuration, versioning, dependencies, and testing.

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

@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 (3)
recipes/r-phylopath/build.sh (1)

2-2: LGTM: Environment variable set correctly. Consider adding a comment.

The environment variable DISABLE_AUTOBREW is set correctly to prevent the use of Homebrew during the build process, which is consistent with Bioconda's approach.

Consider adding a comment to explain the purpose of this variable, for example:

+# Disable automatic brewing of dependencies to ensure a controlled build environment
export DISABLE_AUTOBREW=1
recipes/r-phylopath/meta.yaml (2)

20-44: LGTM: Requirements section is well-defined with a minor optimization possible.

The build, host, and run requirements are correctly specified with appropriate version constraints. The use of 'cross-r-base' for build requirements is correct for cross-compilation.

Consider using YAML anchors and aliases to reduce duplication between host and run requirements. This can make the file more maintainable. For example:

requirements:
  build:
    - cross-r-base {{ r_base }}
  host: &r_requirements
    - r-ape >=4.1
    - r-base
    # ... other dependencies ...
  run: *r_requirements

This change would make future updates easier and reduce the chance of inconsistencies between host and run requirements.


46-48: LGTM: Basic test is present, but consider expanding test coverage.

The current test verifies that the package can be loaded, which is a good basic check.

Consider adding more comprehensive tests to ensure the package functions correctly. For example:

test:
  commands:
    - $R -e "library('phylopath')"
    - $R -e "if (!requireNamespace('testthat', quietly = TRUE)) install.packages('testthat'); testthat::test_package('phylopath')"

This addition would run the package's built-in tests (if available) and provide more confidence in its functionality.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 67be0ec and 5aa25eb.

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

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

(syntax)

🔇 Additional comments (7)
recipes/r-phylopath/build.sh (3)

1-1: LGTM: Correct shebang for bash script.

The shebang #!/bin/bash is correct and follows the standard practice for shell scripts.


1-3: Overall: Well-structured build script for r-phylopath package.

The build.sh script is concise and follows Bioconda's best practices for building R packages. It correctly sets up the build environment and uses the standard R installation command. The script should work as intended for building the r-phylopath package.


3-3: LGTM: R package installation command is correct.

The R command for package installation is correctly structured and follows the standard approach for building R packages in Bioconda.

To ensure the ${R} variable is properly set in the build environment, we can run the following verification script:

This script will help ensure that the ${R} variable is properly set in the build environment.

recipes/r-phylopath/meta.yaml (4)

1-7: LGTM: Package and version section is well-defined.

The package name and version are correctly specified. The use of Jinja2 templating for cross-platform compatibility is appropriate.

🧰 Tools
🪛 yamllint

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

(syntax)


9-11: LGTM: Source section is correctly configured.

The source URL is properly formatted and points to CRAN. The inclusion of a SHA256 checksum ensures package integrity.


13-18: LGTM: Build section is properly configured.

The build number, 'noarch: generic' flag, and R library paths are all correctly specified for this R package.


50-59: LGTM: About section provides comprehensive metadata.

The about section includes all necessary information: home page URL, package summary, and correct license details. The use of an environment variable for the license file path is a good practice.

Copy link

@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/r-phylopath/meta.yaml (1)

47-49: LGTM with suggestion: Consider adding more comprehensive tests.

The current test command verifies that the 'phylopath' library can be loaded, which is a good basic check. However, to ensure the package functions correctly, consider adding more comprehensive tests, such as:

  1. Running a simple analysis using the package.
  2. Checking if key functions are available.
  3. Verifying the package version.

Example:

test:
  commands:
    - $R -e "library(phylopath); stopifnot(packageVersion('phylopath') == '{{ version }}'); res <- phylopath::define_model_set(list(m1 = x ~ y)); print(res)"
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 5aa25eb and 2a15d86.

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

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

(syntax)

🔇 Additional comments (5)
recipes/r-phylopath/meta.yaml (5)

1-7: LGTM: Package and version information looks good.

The package name and version are correctly defined. The use of Jinja2 templating for platform-specific variables is appropriate for ensuring cross-platform compatibility.

🧰 Tools
🪛 yamllint

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

(syntax)


9-11: LGTM: Source information is correctly specified.

The source URL correctly points to CRAN and uses the version variable. The inclusion of the SHA256 checksum is good practice for ensuring package integrity.


13-19: LGTM: Build configuration is well-defined.

The build section is correctly configured:

  • Build number is appropriately set to 0 for a new package.
  • The noarch: generic flag is correctly used for R packages.
  • The run_exports section ensures proper version pinning, which aligns with the PR objectives.
  • R library paths are correctly specified.

21-45: LGTM: Dependencies are well-defined and consistent.

The requirements section is correctly structured:

  • Build and host requirements are appropriately separated.
  • Run requirements match the host requirements, ensuring consistency.
  • Version constraints are properly used where necessary for compatibility.
  • The use of cross-r-base in the build section is correct for cross-compilation scenarios.

51-60: LGTM: Metadata is comprehensive and well-formatted.

The about section provides all necessary metadata:

  • The home page URL is correct and uses HTTPS.
  • The summary clearly describes the package's purpose and cites the relevant paper.
  • License information is correctly specified as GPL-3.0-or-later.
  • The license file path is appropriately set using an environment variable.

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