Rd文件创建时未进行导出

Question

Rd文件创建时未进行导出

3

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

- jfrench

1

@export 是指函数是否被导出，即对用户可用。它与文档是否“导出”无关。非导出函数拥有手册页并不罕见。 - Axeman

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- r2evans · Accepted Answer

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

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

我也喜欢将它们标记为 #' @keywords internal，这样做（根据 vignettes）：

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

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