Check-list to submit on CRAN
I gathered the check-list to submit RLA on CRAN, I took some of advices of https://github.com/ThinkR-open/prepare-for-cran concerning RLA package.
GLOBAL
-
devtools::check()
should return 0 0 0
DESCRIPTION File :
-
Add a copyright owner (cph) in the DESCRIPTION (Maybe we should set Pelagis as cph ?) -
Acronym should be capitalized (Api -> API) and other packages should be delimited by ' -
Fill all DESCRIPTION slot -
Do not put 'in R' or 'with R' in the package title -
Description should be a paragraph, write an elaborated Description field. A CRAN-proof package should have a long description that explains what the package does, what are the benefits, what is new and how does it differ from what is already on the CRAN -
Package title should be in title case, ex : Capital and Lowercase Letters in Titles (Title Case) -
Do not put "This package", package name, title or similar in the Description -
Cite reference
authors (year) <DOI:...> (see <https://en.wikipedia.org/wiki/Digital_object_identifier> )
authors (year) <arXiv:...>
authors (year, ISBN:...)
DOCUMENTATION
-
All the exported functions in your package should have a @return value. If a function does not return a value, document that too. -
Long running examples : If you have examples that take more than a few seconds each to run, wrap them in \donttest{}
, don't usedontrun{}
.
#' \donttest{x <- foo(y)}