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 ntsm recipe https://github.com/JustinChu/ntsm #52262

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

Conversation

JustinChu
Copy link
Contributor

Adding this nucleotide sequence sample swap detection tool: https://github.com/JustinChu/ntsm to bioconda.


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

📝 Walkthrough

Walkthrough

This pull request introduces several new files and configurations for the ntsm package within the recipes/ntsm directory. A LICENSE file has been added, containing the text of the MIT License, which outlines permissions for usage, modification, and distribution of the software while disclaiming warranties. Additionally, a build.sh script has been created to automate the build and installation process, setting necessary environment variables and executing the configuration and make commands. Furthermore, a meta.yaml file has been introduced, detailing the package's metadata, including its name, version (1.1.0), source URL, SHA256 checksum, build and runtime requirements, and testing commands. The metadata also includes an "about" section with project information and an "extra" section that adds support for the linux-aarch64 platform. These changes collectively establish the foundational elements required for the ntsm package's build and installation process.

Possibly related PRs

  • [Add in new package mutamr #51139] Add in new package mutamr: This PR adds a LICENSE file containing the GNU GPL, similar to the addition of the MIT License in the main PR.
  • [Add gene-trajectory-python recipe #51476] Add gene-trajectory-python recipe: This PR also adds a LICENSE file with the MIT License, paralleling the main PR's addition of the same type of file.
  • [Add mutyper #51658] Add mutyper: This PR introduces a LICENSE file for the mutyper package, which is also an MIT License, aligning with the main PR's changes.
  • [Add ntStat #51884] Add ntStat: This PR includes a new LICENSE file for the ntStat package, which specifies the GPL-3.0-or-later license, showing a similar licensing addition as in the main PR.
  • [Add ntStat #51897] Add ntStat: Similar to the previous PR, this one also introduces a LICENSE file for the ntStat package, which specifies the GPL-3.0-or-later license.

Suggested labels

please review & merge

Suggested reviewers

  • mencian
  • bgruening

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 (1)
recipes/ntsm/meta.yaml (1)

32-37: Enhance test coverage.

Current tests only verify command availability. Consider adding:

  1. Version checks for each command
  2. Basic functionality tests with minimal example data
  commands:
    - ntsmCount --help
    - ntsmVCF --help
    - ntsmEval --help
    - ntsmSiteGen -h
+   - ntsmCount --version
+   - ntsmVCF --version
+   - ntsmEval --version
+   - ntsmSiteGen --version
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bc01cb5 and 8b85cfa.

📒 Files selected for processing (3)
  • recipes/ntsm/LICENSE (1 hunks)
  • recipes/ntsm/build.sh (1 hunks)
  • recipes/ntsm/meta.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • recipes/ntsm/LICENSE
  • recipes/ntsm/build.sh
🧰 Additional context used
🪛 yamllint
recipes/ntsm/meta.yaml

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

(syntax)

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

1-5: LGTM! Package metadata follows conda conventions.

🧰 Tools
🪛 yamllint

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

(syntax)


39-46: LGTM! Package metadata is complete.


7-9: Verify source URL accessibility and checksum.


11-13: Verify OSX compatibility restriction.

The recipe skips OSX builds, but the requirements include OSX-specific dependencies (llvm-openmp). This seems inconsistent.


48-50: Verify ARM64 compatibility.

The recipe adds support for linux-aarch64, but we should verify that:

  1. The source code has no x86-specific assembly
  2. All dependencies are available for ARM64
✅ Verification successful

Let me analyze the search results and generate additional verification scripts to check for architecture-specific code.

The first search showed some x86 references but they were mostly in unrelated packages. Let's check the specific recipe and its dependencies to verify ARM64 compatibility.


Let me analyze the recipe and generate one final verification script to check the source code.

This will help verify if there are any architecture-specific implementations in the source code.


ARM64 support appears compatible

The package should work on ARM64 architecture because:

  1. No architecture-specific assembly code or intrinsics were found
  2. The dependencies (zlib, libgomp, samtools, bwa, perl) are all available for ARM64
  3. The code appears to be pure C++ without any architecture-specific optimizations
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for architecture-specific code
# Search for assembly or architecture-specific code
rg -i "asm|__asm__|__attribute__|SIMD|SSE|AVX|x86"

Length of output: 158186


Script:

#!/bin/bash
# Search for assembly files and architecture-specific code in the recipe and source
rg -i "assembly|arch|x86|arm|aarch" recipes/ntsm/

# Check build scripts and dependencies
cat recipes/ntsm/meta.yaml

Length of output: 1111


Script:

#!/bin/bash
# Check source code for any architecture-specific code or assembly
cd recipes/ntsm/
# Look for architecture-specific code patterns in source files
rg -i "asm|simd|avx|sse|intrinsic|x86|amd64|arm|aarch" .

# Check if there are any assembly files
find . -type f -name "*.s" -o -name "*.asm" -o -name "*.S"

Length of output: 170

Comment on lines 15 to 30
requirements:
build:
- {{ compiler('cxx') }}
- llvm-openmp # [osx]
- make
host:
- zlib
- libgomp
run:
- llvm-openmp # [osx]
- zlib
- libgomp
- make
- samtools
- bwa
- perl
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

Add version constraints for runtime dependencies.

Consider adding version constraints for critical dependencies like samtools, bwa, and perl to ensure reproducibility and prevent potential compatibility issues.

Additionally, there might be a conflict between libgomp and llvm-openmp if OSX builds are enabled in the future.

  run:
    - llvm-openmp  # [osx]
    - zlib
    - libgomp
    - make
-   - samtools
-   - bwa
-   - perl
+   - samtools >=1.15
+   - bwa >=0.7.17
+   - perl >=5.26
📝 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
requirements:
build:
- {{ compiler('cxx') }}
- llvm-openmp # [osx]
- make
host:
- zlib
- libgomp
run:
- llvm-openmp # [osx]
- zlib
- libgomp
- make
- samtools
- bwa
- perl
requirements:
build:
- {{ compiler('cxx') }}
- llvm-openmp # [osx]
- make
host:
- zlib
- libgomp
run:
- llvm-openmp # [osx]
- zlib
- libgomp
- make
- samtools >=1.15
- bwa >=0.7.17
- perl >=5.26

- llvm-openmp # [osx]
- zlib
- libgomp
- make
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you need 'make' to run the app ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not for most parts of the program but for a pipeline generating a sites file from a vcf & genome fasta: https://github.com/JustinChu/ntsm/blob/main/ntsmSiteGen

@JustinChu
Copy link
Contributor Author

@BiocondaBot please add label

@BiocondaBot BiocondaBot added the please review & merge set to ask for merge label Nov 23, 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