Release checklist

[gvegayon]

R packages development

Fundamental questions/tasks

• Check for other R packages/software that does what the project tries to do.
• Describe the ultimate goal of your R package (e.g. solve an optim problem, implement a visualization problem, estimate parameters, etc.)
• Think about data (if any needed), in particular, input/output, have you checked any R packages that already have this?
• Create a repository for the package.

Once the project is on git, following checkmarks

• The package uses roxygen2 (you can turn your package Rd files to roxygen using Rd2roxygen).
• The package's functions are thoroughly documented. This includes Description, parameters (@param), value (@return), details (if any), examples (@details), references (@references) and links to other functions (@seealso, and @family).
• The package has been fully tested using testthat or another framework.
• The project is built using Continuous Integration services as Travis-ci and Appveyor (use the usethis package to set it up, eg: usethis::use_travis).
• The package includes a vignette with an extended example and, if needed, references on the package.
• The package has a website (suggest using pkgdown)

Sending a package to CRAN

Prepare for release:

• devtools::check_win_devel()
• rhub::check_for_cran()
• revdepcheck::revdep_check(num_workers = 4)
• Polish NEWS
• If new failures, update email.yml then revdepcheck::revdep_email_maintainers()

Perform release:

• Bump version (in DESCRIPTION and NEWS)
• devtools::check_win_devel() (again!)
• devtools::submit_cran()
• pkgdown::build_site()
• Approve email

Wait for CRAN...

• Tag release
• Bump dev version

Sending a package to Bioconductor

Prepare for release:

• Pass R CMD check and R CMD Biocheck
• Go visit this guidance site
• Add SSH public key(s) to your GitHub account
• Add a webhook to your repository
• Submit by opening a new issue in the Bioconductor Contributions repository.

Perform release:

• Bump version (in DESCRIPTION and NEWS) which triggers the submission
• Receive emails about successfully building your package without errors or warnings.
• A technical review provided by a Bioconductor team member
• Approve email

[gvegayon]

@lailylajiang this is the internal check of R packages that we usually do in USCbiostats. Feel free to follow these guidelines :).