Many of the smaller functions in this package might be considered "internal", and useful to others in only a small minority of special cases. In these cases, there is no need for the @export tag in the rox-header, and even better to add an explicit
#' @keywords internal
tag to the header. The documentation will still be built, but it won't show up in the normal package index. This will help the largest fraction of the intende audience find the main functions we really want them to use. Not-exporting these internal functions helps others import our package without having to worry about name-clashes with other packages. A motivated user will still have access to our functions, and these internal functions can still be directly accessed via
pkgname:::funname()
In general this should feel less like a convention and more like a helpful organizing principle to make it easier on the users.
Many of the smaller functions in this package might be considered "internal", and useful to others in only a small minority of special cases. In these cases, there is no need for the
@exporttag in the rox-header, and even better to add an explicittag to the header. The documentation will still be built, but it won't show up in the normal package index. This will help the largest fraction of the intende audience find the main functions we really want them to use. Not-exporting these internal functions helps others import our package without having to worry about name-clashes with other packages. A motivated user will still have access to our functions, and these internal functions can still be directly accessed via
In general this should feel less like a convention and more like a helpful organizing principle to make it easier on the users.