在roxygen2构建R包时，不显示函数帮助文档

Question

我正在使用devtools来构建R包，有些功能的设计并不是为了对最终用户可见。但是，由于这些函数涉及到通过.Call调用C代码，因此我必须在函数上方编写@useDynLib，以自动生成.Rd文件。这样，当我构建包时，即使我没有为这些函数包含@export，它们仍然会出现在帮助文档中。。。有没有一种方法可以抑制这些函数，即使它们已经被记录下来？谢谢

Answer 1

根据Hadley的评论，使用@keywords internal将使该功能对最终用户不可见。详细信息可以在devtools的wiki页面中找到。

Answer 2

已接受答案中链接的wiki不再讨论@keywords internal(截至2016年4月(。如果有人看到一个例子是有帮助的：

# multiplyBy3
#' This is an example of an internal function called code{multiplyBy3()}
#'
#' Sometimes you want internal functions as part of an R Package built with 
#' RStudio and roxygen2, but you don't want .Rd files created for them
#' or to have them be visible in the help document following the build process
#' 
#' @keywords internal
#'
#' @param base_num The number to multiply by three 
#'
#' @import jsonlite
#'
#' @return Returns a numeric vector
#'
multiplyBy3 <- function(base_number) {
  stopifnot(is.numeric(base_number))
  return(base_number * 3)
}

密钥位：不包括@export，但包括@keywords internal

Answer 3

对我来说，@keywords internal不起作用(roxygen2 6.1.1(。我能够在roxygen评论中使用以下内容来实现所需的结果：

@noRd