R软件包中的代码文档不一致

时间:2020-04-08 04:26:18

标签: r github devtools r-package

在编写和维护R包时,我们需要执行devtools::document来更新NAMESPACE的过程。但是在某些情况下,我们最终在推送到github之前不进行文档更新。因此,我们希望利用tools::codoc或其他方法提供的一些代码文档检查来尝试捕获此类更改。

我注意到tools::codoc函数当前仅检查函数结构之间的不一致。但是有一个过程可以弄清楚导出对象和未导出对象之间的区别。

例如,让我们考虑以下功能

#' @export
f1 <- function(i12){
  return(NULL)
}

发布说明文件,确实创建了该功能的手册文件,并且该文件也已添加到NAMESPACE文件中。对函数参数的任何更改都会显示在代码文档不匹配检查中,但是不再输出函数的更改不会显示在检查中。

有没有办法将其捕获?

0 个答案:

没有答案