CRAN 要求将 \dontrun{} 替换为 \donttest{} 后 R 包中的问题

Question

我向 CRAN 提交了一个包，他们要求我将 Rd 文件中的 \dontrun{} 替换为 \donttest{} 并重新提交。我使用\dontrun{} 来包装一些应该抛出错误消息的示例。

在将\dontrun{} 替换为\donttest{} 后，我进行了一些测试，R CMD check 仍然成功，但现在devtools::check() 和R CMD check --as-cran 都失败了，因为\donttest{} 中包含的示例：

checking examples with --run-donttest ... ERROR

经过一番浏览，我了解到 R 4.0.0 已将 R CMD check --as-cran 更改为运行 \donttest 示例。根据R-devel的NEWS：

"R CMD check --as-cran 现在运行 \donttest 示例（由 example() 运行）而不是指示测试人员这样做。这可以通过设置环境变量在开发过程中临时规避 R_CHECK_DONTTEST_EXAMPLES 为假值。”

由于我打算将包重新提交给 CRAN，因此在本地将 _R_CHECK_DONTTEST_EXAMPLES_ 设置为 false 对我没有帮助。

我还在 devtools 问题中发现了 this 最近的讨论，其中 Hadley Wickham 指出：

“一般来说，现在如果你不想在 CRAN 上运行测试，\dontrun{} 更有可能工作，但使用 \dontrun{} 可能会导致初始提交失败。”

所以现在我不知道如何继续，因为如果我重新提交带有所需更改的包，我已经知道它会在R CMD check --as-cran 中引发错误，因此它可能会导致 CRAN 的自动预测试失败。

编辑：

按照here 的建议，我尝试使用if(interactive()){} 而不是\dontrun{}。此解决方案在R CMD check --as-cran 和devtools::check() 中成功，但我认为这不是解决此问题的最合适方法，因为它不适用于example()（引发错误并且不显示其余示例）。 \dontrun{} 与 example() 一起使用效果更好，因为它会打印所有示例，但会删除使用 \dontrun{} 包裹的示例。

Answer 1

如果你知道某些东西会抛出错误，你可以把它包装在try()中。

## example of failing code
try(stop("Here is an error"))

Answer 2

我认为包示例不适合放置“应该抛出错误消息的示例”。

当您将这些“示例”移至testthat 单元测试时，您的问题将很容易解决。

有

expect_error()
expect_warning()

查看您的包是否按预期抛出警告/错误。

如果您真的想告知用户他们应该避免输入的内容，也许您可​​以将其作为注释添加到示例或其他文档中（详细信息、参数）

您在其他包示例中经常看到的内容如下：

## Example for working
function(x, abc = "5)

## This would give an error because
# function(x, abc = "falsch")

## Working example 2
function(x)
x <- x+y