cran-extrachecks

Solid

Prepare R packages for CRAN submission by checking for common ad-hoc requirements not caught by devtools::check(). Use when: (1) Preparing a package for first CRAN release, (2) Preparing a package update for CRAN resubmission, (3) Reviewing a package to ensure CRAN compliance, (4) Responding to CRAN reviewer feedback. Covers documentation requirements, DESCRIPTION field standards, URL validation, examples, and administrative requirements.

Data & Documents 396 stars 34 forks Updated today MIT

Install

View on GitHub

Quality Score: 91/100

Stars 20%
87
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# CRAN Extra Checks Help R package developers prepare packages for CRAN submission by systematically checking for common ad-hoc requirements that CRAN reviewers enforce but `devtools::check()` doesn't catch. ## Workflow 1. **Initial Assessment**: Ask user if this is first submission or resubmission 2. **Run Standard Checklist**: Work through each item systematically (see below) 3. **Identify Issues**: As you review files, note specific problems 4. **Propose Fixes**: Suggest specific changes for each issue found 5. **Implement Changes**: Make edits only when user approves 6. **Verify**: Confirm all changes are complete ## Standard CRAN Preparation Checklist Work through these items systematically: 1. **Create NEWS.md**: Run `usethis::use_news_md()` if not already present 2. **Create cran-comments.md**: Run `usethis::use_cran_comments()` if not already present 3. **Review README**: - Ensure it includes install instructions that will be valid when the package is accepted to CRAN (usually `install.packages("pkgname")`). - Check that it does not contain relative links. This works on GitHub but will be flagged by CRAN. Use full URLs to package documentation or remove the links. - Does the README clearly explain the package purpose and functionality? - **Important**: If README.Rmd exists, edit ONLY README.Rmd (README.md will be overwritten), then run `devtools::build_readme()` to re-render README.md 4. **Proofread DESCRIPTION**: Carefully review `Title:` and `Descr...

Details

Author
posit-dev
Repository
posit-dev/skills
Created
6 months ago
Last Updated
today
Language
R
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category