R语言【utlis】——vignette()，print()，edit()：查看、列出或获取R包的简介

ALittleHigh2024-02-22 13:08

Package utils version 4.2.0

Description

查看指定的软件包插图，或列出可用的插图；在查看器中显示它，并获取或编辑它的R源文件。

Usage

R 复制代码

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】：一个字符串，给出要查看的小插图的(基本)名称。如果省略，则列出所有已安装包中的所有插图。

参数【package】：包含要搜索的包的名称的字符向量，或者NULL，其中搜索' all '包(由参数all定义)。

参数【lib.loc】：R库的目录名的字符向量，或NULL。默认值NULL对应于当前已知的所有库。

参数【all】：逻辑，如果TRUE，在lib指定的库树中搜索所有可用的包。如果为FALSE，则只搜索附加的包。

参数【x，name】：vignette类的对象。

参数【...】：被 print 方法忽略，传递到 file.edit，使用 edit 方法编辑。

Details

函数vignette返回一个相同类的对象，print方法为它打开一个查看器。

在类unix上，pdfviewer选项指定的程序用于查看PDF版本的小插图。

如果几个插图的PDF/HTML版本的基本名称与主题相同，则使用找到的第一个。

如果没有给出主题，则列出所有可用的插图。相应的信息在类"packageIQR"的对象中返回。