如何在roxygen2中保留注释但不导出S4类且不生成Rd文件
R包roxygen2保留注释但不生成Rd、不导出的实现方案
局部禁用指定对象的Rd生成(最常用)
在setGeneric和setMethod对应的roxygen注释块中添加@noRd标签即可,原有注释内容可以完整保留,roxygen2会跳过为这些对象生成Rd文件。
如果同时需要避免这些泛型、方法被导出到包的对外命名空间,不需要添加@export标签,还可以补充@keywords internal标记为内部对象,避免被文档检索工具识别。
修改后的示例代码如下:
#' @docType methods #' @rdname fun-methods #' @noRd setGeneric("fun", function(...){ standardGeneric("fun") }) #' @rdname fun-methods #' @aliases fun,ANY,ANY-method #' @noRd setMethod("fun", "ANY", function(x, y, ...){ })
全局禁用所有Rd文件生成
如果整个包都不需要生成Rd文档,可直接修改包根目录的DESCRIPTION文件,调整roxygen2的运行配置,移除Rd生成模块:
Roxygen: list(roclets = c("collate", "namespace"))
配置生效后,roxygen2只会处理代码排序和命名空间生成逻辑,所有roxygen注释都可以保留,不会生成任何Rd文件。
内容的提问来源于stack exchange,提问作者Bangyou
相关产品推荐
相关产品推荐

