Question

有时在R帮助页面上，评论中会出现“未运行”这一短语。请在帮助页面中查看“with（）”：

Examples
require(stats); require(graphics)
#examples from glm:
**## Not run:** 
library(MASS)
with(anorexia, {
    anorex.1 <- glm(Postwt ~ Prewt + Treat + offset(Prewt),
                    family = gaussian)
    summary(anorex.1)
})
## End(**Not run**)

示例代码中“未运行”是什么意思？

Answer 1

“not run”包含不应在example函数中执行的代码（例如耗时的代码部分，用户交互......）。

参见例如?example：

详见手册 Writing R Extensions ，作者帮助页面可以标记部分示例中的两个例外规则

'dontrun'包含不应运行的代码。
'dontshow'包含在帮助页面上不可见的代码，但会由包检查工具运行，并且 'example（）'函数。这是以前'testonly'，并且该表格仍然被接受。

Answer 2

在"Writing R Extensions"手册中，在关于\ examples {...}的部分中说

您可以使用\ dontrun {}来显示应该只显示但不能运行的文本，并使用\ dontshow {}获取不应该向用户显示的额外测试命令，但是将通过example（）运行

当你构建一个包时，\ dontrun {}闭包中的所有代码都可以在帮助中看到

## Not run:
...
## End(**Not run**)

编辑：This answer早些时候。

Answer 3

这会添加\donttest{}并从@ hadley R Packages获取（逐字）。

但是出于说明的目的，包含导致错误的代码通常很有用。 \dontrun{} 允许您在示例中包含从未使用过的代码。还有另外两个特殊命令。运行 \dontshow{} ，但未在帮助页面中显示：这对于非正式测试非常有用。 \donttest{} 在示例中运行，但不会在R CMD检查中自动运行。如果您有需要很长时间才能运行的示例，这将非常有用。选项总结如下。

Command      example    help       R CMD check
\dontrun{}                 x
\dontshow{}       x                          x
\donttest{}       x        x

Answer 4

C＆amp; C＆amp;来自Friedrich Leisch必须阅读Creating R Packages: A Tutorial的第5.4章（R文档文件）中的p：

示例部分应包含   可执行的R代码，并自动执行   运行代码是检查的一部分   一套。有两个特别的   示例的标记命令：

dontrun ：内部的所有内容\ dontrun {}   不是由测试执行或   例（）。这对于例如用途是有用的   互动功能，功能   访问互联网等。不要   滥用它会让你的生活更轻松   通过给出不可能的例子   执行。

Answer 5

这里的典型示例可能在rm的帮助页面中：

## Not run: 
## remove (almost) everything in the working environment.
## You will get no warning, so don't do this unless you are really sure.
rm(list = ls())

## End(Not run)

如果执行此操作，当然会产生不良影响。

R帮助页面中“不运行”是什么意思？

5 个答案: