R vignette 查看、列出或獲取包 Vignettes 的 R 源

說明

查看指定的包插圖，或列出可用的包；在查看器中顯示它渲染的內容，並獲取或編輯它R源文件。

用法

vignette(topic, package = NULL, lib.loc = NULL, all = TRUE)

## S3 method for class 'vignette'
print(x, ...)
## S3 method for class 'vignette'
edit(name, ...)

參數

topic	給出要查看的插圖的(基本)名稱的字符串。如果省略，則會列出所有已安裝軟件包的所有小插圖。
package	包含要搜索的包名稱的字符向量，或 NULL，其中搜索 ‘all’ 包(由參數 all 定義)。
lib.loc	目錄名稱的字符向量R Library ，或NULL.默認值為NULL對應於當前已知的所有庫。
all	邏輯性；如果 TRUE 搜索 lib.loc 指定的庫樹中的所有可用包，如果 FALSE ，則僅搜索附加的包。
x , name	類 vignette 的對象。
...	被 print 方法忽略，由 edit 方法傳遞給 file.edit。

細節

函數 vignette 返回同一類的對象， print 方法為其打開一個查看器。

在類 Unix 係統上，pdfviewer 選項指定的程序用於查看 PDF 版本的插圖。

如果多個小插圖的 PDF/HTML 版本的基本名稱與 topic 相同，則使用找到的第一個版本。

如果未給出主題，則會列出所有可用的插圖。相應的信息在類 "packageIQR" 的對象中返回。

例子

## List vignettes from all *attached* packages
vignette(all = FALSE)

## List vignettes from all *installed* packages (can take a long time!):
vignette(all = TRUE)

## The grid intro vignette -- open it
## Not run: vignette("grid") # calling print()
## The same (conditional on existence of the vignettte).
## Note that 'package = *' is much faster in the case of many installed packages:
if(!is.null(v1 <- vignette("grid", package="grid"))) {
## Not run: v1 # calling print(.)
  str(v1)
  ## Now let us have a closer look at the code
  
  
  
  
## Not run: edit(v1) # e.g., to send lines ...
}# if( has vignette "installed")
## A package can have more than one vignette (package grid has several):
vignette(package = "grid")
if(interactive()) {
   ## vignette("rotated")
   ## The same, but without searching for it:
   vignette("rotated", package = "grid")
}

也可以看看

browseVignettes 用於基於 HTML 的暈影瀏覽器； RShowDoc(<basename>, package = "<pkg>") 顯示 “rendered” 小插圖(pdf 或 html)。