使用 R CMD 检查时避免检查“\notrun”示例

Avoid checking "\notrun" examples when using R CMD check

当我 运行 R CMD check 我的包裹 (Ctrl+Shift+ RStudio 中的 E),它还测试我的示例 运行 是否没有错误。

不幸的是,有一些示例不应该 运行 在这种情况下,因为它们涉及与理解相关但与测试无关的外部文件。这些在 ROxygen header.

中用 \dontrun{} 包裹

我知道我可以在 R CMD check 附加选项中使用 --no-examples (RStudio > Build > More > Configure Build Tools),但这根本不会测试任何示例,这不是什么我要。

相反,我希望 R CMD check 到 运行 devtools::run_examples(run=FALSE, fresh = T),这样 \dontrun{} 中的示例就不是 运行。此命令 运行 在控制台中非常完美。

如何在 RStudio 中以这种方式配置 R CMD check

有时,当您更改文档(例如示例)时,旧文件仍保留在包的 man 文件夹中。这就是为什么在 \dontrun{} 中包装示例等更改之后,清理目录是有意义的。您可以使用 roxygen2 通过 运行:

roxygen2::roxygenise(clean = TRUE)