I am using the
devtools package to check if a package I am developing is ready for submission to CRAN.
devtools, I documented a small number of functions with
#'@export, in order for them to be available when the package I am developing is loaded.
However, when I run
devtools::check(), it seems I need to document the functions that are NOT exported, i.e. those that may be called by a function which is exported, but which are not available nor needed by whoever uses the package. Here is an example from the output of
checking Rd \usage sections ... WARNING
Undocumented arguments in documentation object 'calculate_agreement'
Do I need to document those arguments although the function is not exported?
I believe the problem here (based on past experience) is that you are probably using Roxygen comment delimiters
#' in the preamble to the function. This (I'm pretty sure) triggers the creation of a
.Rd file (and the need to document parameters), whether or not you have an
@export directive or not. My solution in this case was to use regular
# commenting rather than
Based on this answer it's possible that an explicit
@keywords internal directive would also work (but I haven't tried it).
@mattb points out that specifying
@noRd should also work.