Prepare chefStats for CRAN submission#21
Open
NNcino wants to merge 7 commits into
Open
Conversation
- Remove Remotes block from DESCRIPTION - Remove testr from Suggests, add withr - Fix DescTools indentation in Imports - Replace testr::create_local_project() in test-use_chefStats.R with withr::local_tempdir() + withr::local_dir() Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Title case: "Provide Methods for Different Statistics" - Expand Description to 3 sentences - Add BugReports field - Remove redundant Maintainer field (Authors@R cre role is sufficient) - Tidy URL field indentation, remove codecov URL Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
These functions have man pages but are not exported. Adding @Keywords internal suppresses the R CMD check note about objects in 'man' that are not exported. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add \examples{} to all 25 exported .Rd files
- Add @examples to all corresponding R source files
- Remove duplicate mean_value definition from by_strata_by_trt.R
(first definition had wrong @return description and used J() instead
of list() for key lookup; second definition is the correct one)
- Clean up duplicate \usage{} and \value{} entries in mean_value.Rd
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…mnog
- Add "J" to globalVariables() to suppress 'no visible global function
definition for J' NOTE in obs_time_by_trt and sd_value
- Replace bare {ramnog} with \pkg{ramnog} in 19 Rd files and all
corresponding R source files to fix 'Lost braces' checkRd warnings
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…URLs Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Test Results 1 files 7 suites 17s ⏱️ Results for commit 7c8bb99. ♻️ This comment has been updated with latest results. |
Adds Remotes: hta-pharma/chef@feature/CRAN_submission so GitHub Actions can
resolve {chef} from GitHub during CI (it is not yet on CRAN). CRAN forbids
Remotes: in submitted tarballs, so tools/strip-remotes.R removes the field
before R CMD build. The helper restores DESCRIPTION afterwards when invoked
with --build, leaving the working tree unchanged.
Both tools/ and cran-plan.md are ignored at build time.
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Code coverage
|
Github pagesReview the pkgdown webpage for the PR here |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR completes all necessary changes to prepare the
{chefStats}package for CRAN submission, addressing blockers and likely CRAN notes/warnings.Changes Made
Blockers (CRAN rejection prevention)
testrdependency — RemovedRemotes:field andtestrfromSuggests:(testr is not on CRAN)withr— Updatedtests/testthat/test-use_chefStats.Rto usewithr::local_tempdir()andwithr::local_dir()instead oftestr::create_local_project()\examples{}sections to all 25 exported function documentation files, with small inline data.table examples tailored to eachfunction
@keywords internaltobarnard_test_andbreslowdaytest_to exclude them from public exportsLikely Notes / Warnings (CRAN reviewer pushback prevention)
BugReports:field pointing to GitHub issuesMaintainer:field (relying onAuthors@R)Imports:indentation (DescTools was using tabs instead of spaces)withrtoSuggests:Files Modified
DESCRIPTION— metadata updates and dependency fixestests/testthat/test-use_chefStats.R— replaced testr with withrR/*.R— added roxygen comments with @examples and @Keywords internal where neededman/*.Rd— auto-generated from roxygen (examples and internal markings)README.md— fixed URL redirectsCRAN Compliance Status
All CRAN blockers and likely notes have been addressed. Ready for local check (
R CMD check --as-cran .) and CRAN submission viarhub::check_for_cran().Testing
withrpackage