R语言:vignette()函数中文帮助文档(中英文对照)

loveR

vignette(utils)
vignette()所属R语言包：utils

                                        View or List Vignettes
                                         查看或名单的小故事

                                         译者：生物统计家园网 机器人LoveR

描述----------Description----------

View a specified vignette, or list the available ones.
查看指定的小品文，或列出可用的。


用法----------Usage----------


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

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



参数----------Arguments----------

参数：topic
a character string giving the (base) name of the vignette to view. If omitted, all vignettes from all installed packages are listed.
一个字符串，给人的暗角（基地）的名称可查看。如果省略，列出所有已安装软件包的所有护身符。


参数：package
a character vector with the names of packages to search through, or NULL in which "all" packages (as defined by argument all) are searched.
与特征向量的套件名称进行搜索，或NULL“所有”包（参数all定义）进行搜索。


参数：lib.loc
a character vector of directory names of R libraries, or NULL.  The default value of NULL corresponds to all libraries currently known.
特征向量的研发图书馆的目录名，或NULL。默认值的NULL对应于目前已知的所有库。


参数：all
logical; if TRUE search all available packages in the library trees specified by lib.loc,  and if FALSE, search only attached packages.
逻辑;如果TRUE搜索所有可用的软件包在lib.loc指定的库树，如果FALSE，只搜索附加的软件包。


参数：x, name
Object of class vignette.
对象类vignette。


参数：...
Ignored by the print method, passed on to file.edit by the edit method.
忽略print方法传递file.editedit方法，。


Details

详情----------Details----------

Function vignette returns an object of the same class, the print method opens a viewer for it. Currently, only PDF versions of vignettes can be viewed. If several vignettes have PDF versions with base name identical to topic, the first one found is used.
功能vignette返回一个相同的类的对象，打印方法，打开了它的观众。目前，只有PDF版本的护身符，可以查看。如果有几个护身符基本名称相同topicPDF版本，第一个找到的。

If no topics are given, all available vignettes are listed.  The corresponding information is returned in an object of class "packageIQR".
如果没有给出主题，列出所有可用的护身符。相应的信息中返回一个对象类"packageIQR"。

The edit method extracts the R code from the vignette to a temporary file and opens the file in an editor (see edit). This makes it very easy to execute the commands line by line, modify them in any way you want to help you test variants, etc.. An alternative way of extracting the R code from the vignette is to run Stangle on the source code of the vignette, see the examples below.
edit方法提取的R代码从插曲到一个临时文件，并在编辑器中打开文件（见edit）。这使得它很容易，执行命令行，在任何你想要的方式来帮助你测试的变种，等他们修改。提取的小插曲R代码的另一种方法是运行Stangle上的暗角的源代码，看下面的例子。


参见----------See Also----------

browseVignettes for an HTML-based vignette browser.
browseVignettes一个基于HTML的小插曲浏览器。


举例----------Examples----------


## List vignettes from all *attached* packages[＃列出所有*附*包护身符]
vignette(all = FALSE)

## List vignettes from all *installed* packages (can take a long time!):[＃列出所有*安装包（可能需要很长的时间！）护身符：]
vignette(all = TRUE)

## Not run: [＃无法运行：]
## Open the grid intro vignette[＃打开格介绍的小插曲]
vignette("grid")

## The same[＃]
v1 <- vignette("grid")
print(v1)

## Now let us have a closer look at the code[＃现在，让我们仔细看看有代码]
edit(v1)

## An alternative way of extracting the code,[＃提取代码的替代方式，]
## R file is written to current working directory[＃R文件被写入到当前工作目录]
Stangle(v1$file)

## A package can have more than one vignette (package grid has several):[＃一个包可以有一个以上的小插曲（包网格有几个）：]
vignette(package="grid")
vignette("rotated")
## The same, but without searching for it:[＃相同，但不寻找它：]
vignette("rotated", package="grid")

## End(Not run)[＃结束（不运行）]

转载请注明:出自 生物统计家园网(http://www.biostatistic.net)。


注：
注1：为了方便大家学习，本文档为生物统计家园网机器人LoveR翻译而成，仅供个人R语言学习参考使用，生物统计家园保留版权。
注2：由于是机器人自动翻译，难免有不准确之处，使用时仔细对照中、英文内容进行反复理解，可以帮助R语言的学习。
注3：如遇到不准确之处，请在本贴的后面进行回帖，我们会逐渐进行修订。