finish-CRAN-checklist

[dan9401]

Reference links:

1. Submit a package to CRAN
2. Checklist for CRAN submissions
3. R Packages - Releasing to CRAN

[EchoRLiu]

From Submit a package to CRAN:

• [x] The package contains a DESCRIPTION file.
• [x] DESCRIPTION file contains the valid maintainer field "NAME ".
• [ ] You submit a tar.gz created with R CMD build.
• [ ] You are familiar with the rest of the CRAN policies
  • [ ] copyright related as in issue #37
  • [ ] 1 single designated maintainer only
  • [ ] citation, author-year DOI/ISBN/URL
  • [ ] no binary executable code (if we do, include in .Rbuildignore
  • [ ] the open-source requirement is a bit ambiguous, accoring to Claude, the only relevant action for us is to ensure the packages we use are all open-source.

    Source packages under an Open Source license ...

  • [x] cross-platform (checked by GitHub Actions)
  • [ ] package name should have no conflict with CRAN and Bioconductor
  • [ ] also check the packages we use are from a mainstream repository (supposedly CRAN and Bioconductor)
  • [ ] check the packages we use are the current version (not developement, but maybe not the older versions either)
  • [ ] data and documentation should not exceed 5MB (before tarball compression??), the source tarball (.tar.xz) should not exceed 10MB
  • [ ] make long-running tests and vignette optional? (we only have a 10 second example that is taking a bit long, see if we can profile and trim the time)
  • [ ] no malicious code (check the list)
  • [ ] secure additional downloads (should not apply to us)

[dan9401]

From Checklist for CRAN submissions combined with the sumbission section of Submit a package to CRAN:

• [X] run R CMD check --as-cran
  • The github action runs R CMD check thru rcmdcheck() function with --as-cran as default arg: https://github.com/r-lib/actions/blob/v2-branch/check-r-package/action.yaml, but still run R CMD check --as-cran {package}_{version}.tar.gz before submission
  • [ ] No ERROR WARNING or significant NOTE.
  • [ ] R CMD build in R-patched version, or R-release version
  • [ ] R CMD check --as-cran on R-devel version?
  • [ ] URL check?
• [ ] DESCRIPTION
  • [ ] have more informative Description
  • [ ] include citation of the robust garch paper, use {author_last_name} ({year}) <doi:{doi}>, also relevant URLs if any
  • [ ] change Author to Authors@R field?

    Fields ‘Author’ and ‘Maintainer’ can be auto-generated from ‘Authors@R’ https://cran.r-project.org/doc/manuals/r-devel/R-exts.html#The-DESCRIPTION-file-1

  • [ ] add ORCID
• [ ] check package (reverse) dependency versions??

  For a package update, please check that any packages depending on this one still pass R CMD check: it is especially expected that you will have checked your own packages. Reverse dependencies can conveniently be checked using tools::check_packages_in_dir(reverse = list()), and changes in check status subsequently be analyzed using tools::check_packages_in_dir_changes(). A listing of the reverse dependencies of the current version can be found on the CRAN web page for the package, or be obtained via tools::package_dependencies(reverse = TRUE). If possible, check reverse strong dependencies, reverse suggests and the recursive strong dependencies of these (by tools::package_dependencies(reverse = TRUE, which = "most", recursive = "strong")).

[dan9401]

Read this section carefully: https://r-pkgs.org/release.html#sec-release-initial. add additional notes regarding the entire article

And a few things to check here: https://github.com/[DavisVaughan/extrachecks](https://github.com/DavisVaughan/extrachecks)