Rd创建但未导出

Posted 2021-05-04

我正在记录内部的非导出函数。即使文档中没有@export标记，roxygen2仍在创建Rd文件。 roxygen2为以下文档创建了Rd文件。我想念什么？

    #' Check validity of a
    #' @param a A logical value
    arg_check_a = function(a) {
      if (!is.logical(a)) {
        stop("a must be a logical value")
      }
    }

答案

使用@noRd。

使用@noRd标签防止生成.Rd文件。

我也是将它们标记为@noRd的粉丝，（根据#' @keywords internal）：

vignettes是有用的，因为它从文档索引中删除了该功能；对于主要针对其他开发人员而不是软件包的典型用户的功能很有用。

（其中大部分来自@keywords internal）