调试Roxygen 2文档

时间:2013-12-27 17:08:20

标签: r debugging documentation roxygen2

我有一个非常大的项目,包含约120个文件,每个文件约50行文档。 Roxygen2是记录我的代码的救命稻草,但我遇到了修复损坏文档的一些棘手问题。当我从Rstudio运行roxygenise时,我收到以下错误。

==> roxygenize('.', roclets=c('rd', 'namespace'))

* checking for changes ... ERROR

Error : family requires a value

消息相当清楚,但不清楚它来自哪个文件。我在项目中有超过500个家庭标签,因此手动搜索它们并不容易,当然也不是长期解决方案。

有没有办法将roxygen错误本地化到特定文件?我想通过循环中的每个文件来实现这是可能的,但我无法弄清楚如何做到这一点。

任何帮助,煽动或脚本都会受到赞赏,如果需要澄清,请在下面留言。

1 个答案:

答案 0 :(得分:3)

如果您使用的是UNIX系统或使用cygwin的Windows,则可以运行:

grep -r -e "@family\s*$" ./

来自包含您文件的目录。如果不是大多数文本编辑器都有文件中的正则表达式选项。

如果问题是您的家庭标签格式不正确而不是只是遗漏,这并不保证会受到影响,但可能会有效。如果是后一个问题那么你应该从@BenBolker建议的那个开始。