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

有时在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**) 

示例代码中的“不运行”是什么意思?

“不运行”包含了不应该在example函数中执行的代码(例如,耗时的代码部分,用户交互等)。

请参阅?example

正如编写R扩展手册中详细介绍的那样,帮助页面的作者可以为两个例外规则标记部分示例

  • “dontrun”包含不应该运行的代码。

  • 'dontshow'包含在帮助页面上不可见的代码,但将由包检查工具和“example()”函数运行。 这以前是“纯粹的”,而且这种forms仍然被接受。

在“Writing R Extensions”手册中,关于\ examples {…}的部分就是这样说的

对于不应该显示给用户的额外testing命令,您可以使用\ dontrun {}来显示应该只显示但不运行的文本,\ dontshow {}可以使用example()

当你构build一个包时,\ dontrun {}闭包中的所有代码在帮助中都是可见的

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

编辑: 这个答案更早。

这增加了\donttest{}并从@ hadley的R Packages中被逐出(逐字)。

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

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

创buildR包的第5.4章(R Documentation文档)中的C&p : Friedrich Leisch的一个教程 :

示例部分应包含可执行的R代码,并自动运行代码是检查包的一部分。 这个例子有两个特殊的标记命令:

dontrun :\ dontrun {}中的所有内容都不会被testing或示例()所执行。 这对于交互式function,访问互联网的function等是很有用的。不要滥用它,通过给出无法执行的例子来使您的生活更轻松。