R example 运行在线帮助中的示例部分

说明

运行所有R代码来自例子部分R的在线帮助主题topic可能有例外dontrun,dontshow， 和donttest，请参阅下面的“详细信息”。

用法

example(topic, package = NULL, lib.loc = NULL,
        character.only = FALSE, give.lines = FALSE, local = FALSE,
        type = c("console", "html"), echo = TRUE,
        verbose = getOption("verbose"),
        setRNG = FALSE, ask = getOption("example.ask"),
        prompt.prefix = abbreviate(topic, 6),
        run.dontrun = FALSE, run.donttest = interactive())

参数

topic	名称或文字字符串：应运行其示例的在线help主题。
package	当使用 search 路径上的所有包时，给出要查找主题的包名称的字符向量，或 NULL(默认值)。
lib.loc	目录名称的字符向量R Library ，或NULL.默认值为NULL对应于当前已知的所有库。如果使用默认值，则在库之前搜索加载的包。
character.only	指示topic是否可以假定为字符串的逻辑。
give.lines	逻辑：如果为 true，则示例源代码的行将作为字符向量返回。
local	逻辑：如果 TRUE 在本地计算，如果 FALSE 在工作区计算。
type	字符：是否在控制台或浏览器中显示输出(使用动态帮助系统)。仅在交互式会话中并且安装了 knitr 包时才支持后者。在这种情况下，其他几个参数将被默默忽略，包括 setRNG 和 lib.loc 。
echo	逻辑性；如果TRUE，显示R采购时输入。
verbose	逻辑性；如果 TRUE ，则在运行示例代码时显示更多。
setRNG	逻辑或表达；如果不是 FALSE ，则保存随机数生成器状态，然后初始化为指定状态，运行示例并恢复(保存的)状态。 setRNG = TRUE 设置与 R CMD check 运行包示例时相同的状态。目前这相当于 setRNG = {RNGkind("default", "default", "default"); set.seed(1)} 。
ask	逻辑(或 "default" )指示在示例代码中发生图形输出之前是否应调用 devAskNewPage(ask = TRUE) 。值 "default"(factory-fresh 默认值)表示询问 echo 是否为 true 并且图形设备是否显示为交互式。此参数既适用于任何当前打开的设备，也适用于示例代码打开的任何设备。
prompt.prefix	特点;如果 echo 为 true(默认情况下)，则为要使用的提示添加前缀。
run.dontrun	逻辑表明应忽略⁠\dontrun⁠。
run.donttest	逻辑表明应忽略⁠\donttest⁠。

细节

如果未指定 lib.loc ，则会在已加载的包中搜索包，然后在 .libPaths() 给出的库中搜索包。如果指定了lib.loc，则仅在指定的库中搜索包，即使它们已从另一个库加载。搜索将停止在找到的第一个对该主题有帮助的包处。

在运行示例之前尝试加载包，但这不会替换从其他位置加载的包。

如果 local = TRUE 对象未在工作区中创建，因此在 example 完成后不可用于检查：另一方面，它们无法覆盖工作区中同名的对象。

正如《Writing R Extensions》手册中详细介绍的那样，帮助页面的作者可以标记异常规则的部分示例

dontrun

包含不应运行的代码。

dontshow

包含在帮助页面上不可见的代码，但将由包检查工具和example() 函数运行。这以前是 testonly ，并且该形式仍然被接受。

donttest

包含通常应该运行但不在包检查期间运行的代码。默认的 run.donttest = interactive() 导致其他帮助页面示例中使用 example() 来适当跳过 ⁠\donttest⁠ 部分。

值

最后计算的表达式的值，除非 give.lines 为 true，此时返回 character 向量。

例子

example(InsectSprays)
## force use of the standard package 'stats':
example("smooth", package = "stats", lib.loc = .Library)

## set RNG *before* example as when R CMD check is run:

r1 <- example(quantile, setRNG = TRUE)
x1 <- rnorm(1)
u <- runif(1)
## identical random numbers
r2 <- example(quantile, setRNG = TRUE)
x2 <- rnorm(1)
stopifnot(identical(r1, r2))
## but x1 and x2 differ since the RNG state from before example()
## differs and is restored!
x1; x2

## Exploring examples code:
## How large are the examples of "lm...()" functions?
lmex <- sapply(apropos("^lm", mode = "function"),
               example, character.only = TRUE, give.lines = TRUE)
lengths(lmex)

作者

Martin Maechler and others

也可以看看

demo