pecan icon indicating copy to clipboard operation
pecan copied to clipboard

make /base/logger (PEcAn.logger ) package CRAN ready

Open moki1202 opened this issue 4 years ago • 3 comments

The primary aim of this issue is to make our package PEcAn.logger, CRAN ready. To achieve this, we would be following strict guidelines and policies set by the CRAN team.

Following are the necessary checkboxes that need to be ticked before we think about releasing the package-

  • [x] R CMD check should not return any warnings, notes and errors. One exception: Since the package has never been on CRAN before, "checking CRAN incoming feasibility" will always return a NOTE stating the maintainer name and the package license.
  • [x] An additional NEWS.md file should be added to each package. It should list all the API changes in each release.
  • [x] It should meet every requirement mentioned by CRAN in this document
  • [x] Any package about to be released to CRAN must not depend on any other NON-CRAN package!
  • [x] Check that the package maintainer is correctly assigned and their email is up to date.
  • [x] Review descriptive text in DESCRIPTION and make sure it clearly describes the purpose of this package (not just PEcAn as a whole).
  • [x] Delete tests/Rcheck_reference.log
  • [x] Bump version and date!
  • [x] no Roxygen example section for un-exported functions.
  • [x] exported functions should have return value documentation.
  • [x] assign cph(copyright holder) role.

moki1202 avatar Jun 28 '21 08:06 moki1202

~Two~Three more that will apply to any R package but are especially important because of PEcAn's monorepo history:

  • [ ] Check that package maintainer is correctly assigned and their email is up to date
  • [ ] Review descriptive text in DESCRIPTION and make sure it clearly describes the purpose of this package (not just PEcAn as a whole)
  • [ ] Bump version

infotroph avatar Jun 28 '21 12:06 infotroph

Reopening to track the last few tasks -- #2815 knocked out all the check errors (huzzah!), but we want to do a bit more polishing before sending it to CRAN.

infotroph avatar Jul 21 '21 20:07 infotroph

This issue is stale because it has been open 365 days with no activity.

github-actions[bot] avatar Jul 15 '23 00:07 github-actions[bot]