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)。