没有导出创建的 Rd

【问题标题】：Rd created without export没有导出创建的 Rd
【发布时间】：2020-02-13 22:57:49
【问题描述】：

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

【问题讨论】：

@export 是关于函数是否被导出，即是否可供用户使用。这与文档是否“导出”无关。非导出函数有手册页的情况并不少见。

标签： r roxygen2

【解决方案1】：

使用@noRd。

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

我也喜欢标记他们#' @keywords internal，其中（根据vignettes）：

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

（大部分来源于https://github.com/r-lib/roxygen2/issues/684）

【讨论】：

也许我可以看到一些实用程序，感谢您提供元链接，@NelsonGon。