-
Notifications
You must be signed in to change notification settings - Fork 5
Release: prepare for first CRAN release #5
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
base: master
Are you sure you want to change the base?
Conversation
…to preserve data frame structure
…nd NEWS files, and include cran-comments
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 surveytoolbox package for its first CRAN release by adding comprehensive test coverage, two vignettes, updating documentation, and ensuring CRAN compliance.
Changes:
- Added comprehensive test suite with testthat covering all major package functions
- Created two vignettes: "Getting Started" and "surveytoolbox Walkthrough" providing practical examples
- Updated function documentation with proper
@returntags and improved descriptions - Enhanced platform-specific handling for Windows-only clipboard functions
- Updated GitHub Actions workflow to test across multiple OS and R versions
- Added CRAN submission files (cran-comments.md, LICENSE.md, NEWS.md)
- Updated DESCRIPTION file with proper Authors@R format and comprehensive package description
- Removed deprecated
mutate_atcalls from examples
Reviewed changes
Copilot reviewed 81 out of 82 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| DESCRIPTION | Updated to CRAN-ready format with proper metadata and dependencies |
| NAMESPACE | Added new exports and imports for new functions and dependencies |
| NEWS.md | Documents initial CRAN release with feature list |
| LICENSE.md | Added GPL-3 license reference |
| cran-comments.md | CRAN submission notes documenting test environments |
| vignettes/surveytoolbox-walkthrough.Rmd | Comprehensive walkthrough of all package functions |
| vignettes/getting-started.Rmd | Quick start guide for common use cases |
| tests/testthat/test-*.R | Comprehensive test suite covering all major functions |
| R/*.R | Updated documentation with @return tags and platform checks |
| man/*.Rd | Regenerated documentation files from updated roxygen |
| .github/workflows/R-CMD-check.yaml | Enhanced CI workflow for multi-platform testing |
| README.md | Removed "under development" messaging |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #' @param x Log-linear model to be passed through | ||
| #' | ||
| #' @return a [tibble][tibble::tibble-package] | ||
| #' |
Copilot
AI
Jan 28, 2026
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.
Duplicate documentation tags found. There are two @param x tags (lines 10 and 16) and two @return tags (lines 12 and 18) in the roxygen documentation. Remove the duplicate tags at lines 16-18 to avoid roxygen2 warnings.
| #' @param x Log-linear model to be passed through | |
| #' | |
| #' @return a [tibble][tibble::tibble-package] | |
| #' |
|
|
||
| # NPS categories | ||
| nps_category = as_nps(nps), | ||
| # Satisfaction as percentage (for reporting) |
Copilot
AI
Jan 28, 2026
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.
Inconsistent indentation of comment. The comment on line 98 is not properly aligned with the code block. It should be indented at the same level as the other lines within the mutate call.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…nctc/surveytoolbox into release/first-cran-release
Summary
This PR prepares the
surveytoolboxpackage for its first CRAN release.This PR introduces a robust test suite for the surveytoolbox package using testthat, significantly improving code reliability and maintainability.
Changes
🔧 Functions Tested
Comprehensive test coverage for core package functions including:
any_x- Enhanced any() function with NA handlingas_percent- Number to percentage conversionbox_it- Binary variable creation with labelsCAGR- Compound annual growth rate calculationsclean_strings- Variable name cleaningapply_row- Rowwise operationslook_up- Lookup table functionalitywrap_text- Text wrapping for visualizationsset_varl,set_vall)as_nps)maxmin,create_named_list,likert_convert)Checks
roxygen2::roxygenise()has been run prior to merging to ensure that.RdandNAMESPACEfiles are up to date.NEWS.mdhas been updated.Change Type
Please check the type of change your PR introduces:
Notes
This fixes #<issue_number>
<other things, such as how to incorporate new changes>