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