-
Notifications
You must be signed in to change notification settings - Fork 22
Preparing for CRAN release #54
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
Conversation
Hey, @aoliveram, I'll be polishing some bits before we submit the new version to CRAN. I may ask you to go over the changes (if you have time!). |
No problem @gvegayon . I'll have some time next week. Please LMK if I can help you ;) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good work! It looks more readable now, and you added split_behaviors to the man/ folder.
I still need to replace the vignette's .png files with some .html tables.
On the other hand, there is no mention of the current workshop repository (https://github.com/USCCANA/netdiffuser-workshop), so I'd put it in the NEWS file as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR prepares the package for CRAN release by updating version metadata, refactoring documentation, and improving code structure for multi-diffusion models.
- Updated package metadata and version information.
- Revised documentation (Rd files, README, NEWS) and examples to reflect new API changes.
- Refactored several functions (rdiffnet, new_diffnet, split_behaviors) and Makefile improvements.
Reviewed Changes
Copilot reviewed 25 out of 25 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
netdiffuseR.Rproj | Added a ProjectId field for improved project metadata. |
man/*.Rd | Updated documentation for various functions, including behavior and usage changes. |
inst/CITATION, NEWS.md, DESCRIPTION | Updated citation details, version, and release notes. |
README.qmd & README.md | Modified installation instructions and badge links; use of remotes over devtools. |
R/rdiffnet.r, R/diffnet-methods.r, R/diffnet-class.r, R/diffnet-methods.r | Refactored code for enhanced maintainability and clearer error messages. |
Makefile | Adjusted build instructions and regex pattern for version extraction. |
.devcontainer/* | Added dev container configuration for a consistent development environment. |
Comments suppressed due to low confidence (2)
R/rdiffnet.r:795
- Ensure that the meta behavior is consistently stored as a list so that splitting behaviors works reliably. It may be beneficial to validate or explicitly convert meta$behavior to a list to avoid potential type mismatches.
behaviors_names <- diffnet_obj$meta$behavior
Makefile:1
- Verify that the updated regex pattern with the extra escape sequence in the Makefile correctly extracts the version from DESCRIPTION as intended. The additional backslash may affect the matching pattern, so confirm its expected behavior across environments.
VERSION:=$(shell Rscript -e 'x<-readLines("DESCRIPTION");cat(gsub(".+[:]\\s*", "", x[grepl("^Vers", x)]))')
No description provided.