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

chore: Update docs for R, fix binding, test, and easy install #97

Merged
merged 8 commits into from
Jan 6, 2025

Conversation

lsetiawan
Copy link
Member

@lsetiawan lsetiawan commented Jan 2, 2025

This pull request includes several changes to add CI for R, improve the R package phylo2vec, and update documentation and testing. The most important changes include setting up a CI workflow for R, adding new tasks and dependencies in pixi.toml, exporting functions in the R package, and updating the README with installation and usage instructions.

CI Setup:

  • .github/workflows/ci-R.yml: Added a new GitHub Actions workflow for CI with R to build and test the project on pushes and pull requests.

Package Configuration:

  • pixi.toml: Added new tasks for installing and testing the R package, and specified the R version and dependencies.

R Package Improvements:

Documentation Updates:

  • r-phylo2vec/README.md: Updated README with quick installation and usage instructions, as well as a development guide for adding Rust bindings.

Testing:

Related Issues

Part of #4 and #5

Copy link

deepsource-io bot commented Jan 2, 2025

Here's the code health analysis summary for commits ef96fce..ef4860e. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Rust LogoRust✅ SuccessView Check ↗
DeepSource Python LogoPython✅ SuccessView Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

@lsetiawan lsetiawan changed the title chore: Update docs for R and fix binding chore: Update docs for R, fix binding, test, and easy install Jan 2, 2025
@lsetiawan lsetiawan requested a review from Copilot January 2, 2025 23:47

Choose a reason for hiding this comment

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

Copilot reviewed 4 out of 11 changed files in this pull request and generated no comments.

Files not reviewed (7)
  • r-phylo2vec/DESCRIPTION: Language not supported
  • r-phylo2vec/NAMESPACE: Language not supported
  • r-phylo2vec/R/extendr-wrappers.R: Language not supported
  • r-phylo2vec/scripts/install-package.R: Language not supported
  • r-phylo2vec/scripts/run-tests.R: Language not supported
  • r-phylo2vec/tests/testthat.R: Language not supported
  • r-phylo2vec/tests/testthat/test_to_newick.R: Language not supported
Comments suppressed due to low confidence (2)

r-phylo2vec/src/rust/src/lib.rs:17

  • The function 'to_newick' does not have a corresponding test case to verify its behavior. Please add a test case for this function.
fn to_newick(input_integers: Vec<i32>) -> String {

r-phylo2vec/README.md:6

  • The word 'pylo2vec' should be 'phylo2vec'.
This directory contains the pylo2vec R codebase, which includes Rust binding
Copy link

@madelinegordon madelinegordon left a comment

Choose a reason for hiding this comment

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

LGTM!

r-phylo2vec/README.md Outdated Show resolved Hide resolved
r-phylo2vec/README.md Outdated Show resolved Hide resolved
Copy link

sonarqubecloud bot commented Jan 6, 2025

@lsetiawan lsetiawan merged commit 0f5d83e into uw-ssec:dev Jan 6, 2025
10 checks passed
@lsetiawan lsetiawan deleted the update-R branch January 6, 2025 18:32
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