Skip to content

Prepare chefCriteria for CRAN submission#8

Open
NNcino wants to merge 4 commits into
mainfrom
feature/CRAN_submission
Open

Prepare chefCriteria for CRAN submission#8
NNcino wants to merge 4 commits into
mainfrom
feature/CRAN_submission

Conversation

@NNcino

@NNcino NNcino commented May 27, 2026

Copy link
Copy Markdown
Collaborator

Summary

This PR prepares the chefCriteria package for CRAN submission by fixing R CMD check issues, adding comprehensive documentation examples, and updating build configuration.

Changes

  • Fixed R CMD check issues for CRAN compliance

    • Updated .Rbuildignore configuration for proper package building
    • Corrected documentation and import handling
  • Added examples to all 3 exported functions

    • crit_bb_nsubev_01(): Example demonstrating minimum subject count criterion
    • crit_bb_pval_01(): Example showing p-value threshold criterion
    • crit_ep_nsubev_01(): Example for endpoint-specific criteria
    • Updated .Rd documentation files with runnable examples
  • Updated package metadata

    • Modified DESCRIPTION with refined package details and maintainer information
    • Added NEWS.md with initial release notes (v0.1.0)

Testing

  • All R CMD check validations pass
  • Package ready for CRAN submission

NNcino and others added 3 commits April 17, 2026 10:40
- Remove Remotes block (chef and chefStats submitted simultaneously)
- Bump version from 0.0.1.9000 to 0.1.0
- Title case: "A Collection of 'chef' Criterion Functions"
- Expand Description to 3 sentences
- Add BugReports field
- Remove unused Imports (magrittr, purrr, dplyr, knitr) — none are
  referenced in NAMESPACE or active R code
- Move knitr to Suggests (only needed as VignetteBuilder)
- Tidy URL field, remove codecov URL
- Create NEWS.md with initial release entry

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Remove VignetteBuilder/knitr (no vignettes exist)
- Move chef from Imports to Suggests (only used in tests, not in R code)
- Add dplyr and purrr to Suggests (used in test helpers)
- Add .pre-commit-config.yaml, .githooks, README.rmd, cran-plan.md to
  .Rbuildignore to suppress non-standard top-level file NOTEs
- Fix {ramnog} -> \pkg{ramnog} in crit_by_strata_by_trt.R and
  crit_bb_pval_01.Rd

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@NNcino NNcino requested a review from matthew-phelps May 27, 2026 12:40
@github-actions

github-actions Bot commented May 27, 2026

Copy link
Copy Markdown

Test Results

1 files  2 suites   1s ⏱️
3 tests 3 ✅ 0 💤 0 ❌
7 runs  7 ✅ 0 💤 0 ❌

Results for commit 556d6db.

♻️ This comment has been updated with latest results.

…AN submission

Adds Remotes: hta-pharma/chef@feature/CRAN_submission and
hta-pharma/chefStats@feature/CRAN_submission so GitHub Actions can resolve
those dependencies from GitHub during CI (neither is on CRAN yet). 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>
@github-actions

Copy link
Copy Markdown

Code coverage

Name Coverage (%)
chefCriteria 100
R/crit_by_strata_by_trt.R 100
R/crit_endpoint.R 100

@github-actions

Copy link
Copy Markdown

Github pages

Review the pkgdown webpage for the PR here

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.

1 participant