r - 没有导出创建的 Rd

Question

我正在记录一个内部的、非导出的函数。roxygen2 正在创建一个 Rd 文件，即使@export文档中没有标签。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")
      }
    }

标签： rroxygen2

Answer 1

使用@noRd.

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

我也是标记它们的粉丝#' @keywords internal，其中（根据小插图）：

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

（其中大部分来自https://github.com/r-lib/roxygen2/issues/684）