R buildVignettes 列出并构建包插图

说明

在包的所有小插图上运行Sweave(或其他自定义编织函数)和texi2pdf，或列出小插图。

用法

buildVignettes(package, dir, lib.loc = NULL, quiet = TRUE,
               clean = TRUE, tangle = FALSE, skip = NULL,
               ser_elibs = NULL)

pkgVignettes(package, dir, subdirs = NULL, lib.loc = NULL,
	     output = FALSE, source = FALSE, check = FALSE)

参数

package	命名已安装包的字符串。如果给定，则默认在子目录“中查找晕影源文件文档’。
dir	指定包根源目录路径的字符串。如果给定，则默认在子目录“中查找晕影源文件小插图’。
lib.loc	目录名称的字符向量R Library ，或NULL.默认值为NULL对应于当前已知的所有库。指定的库树用于搜索package.
quiet	合乎逻辑的。在安静模式下编织并运行texi2pdf。
clean	删除构建生成的所有文件，即使之前有副本。
tangle	合乎逻辑的。既要编织，又要缠结。
skip	小插图名称的字符向量(没有文件扩展名，匹配names从返回pkgVignettes) 应该被跳过，或者TRUE跳过那些不可用的‘⁠\VignetteDepends⁠' (从vignetteInfo)。
ser_elibs	供 R CMD check 使用。
subdirs	dir 子目录的字符向量，在其中查找小插图。使用第一个存在的。如果提供了package，则默认为"doc"，否则为"vignettes"。
output	逻辑指示是否应返回每个小插图的输出文件名(在组件 outputs 中)。
source	逻辑指示是否应返回每个小插图的混乱输出文件名(在组件 sources 中)。
check	合乎逻辑的。如果 TRUE ，请检查所有具有 vignette-like 文件名的文件是否具有可识别的晕影引擎。如果文件不是晕影但其文件名与晕影引擎之一定义的模式匹配，则这可能是误报。

细节

buildVignettes 由 R CMD build 和 R CMD check 用于从其源(重新)构建晕影输出。

来自R3.4.1，这两个函数都会忽略‘.Rbuildignore' 文件中dir.

值

buildVignettes被调用是因为它创建所有小插图的输出的副作用，并且如果tangle = TRUE，提取R代码。

如果找到小插图目录，pkgVignettes 返回类 "pkgVignettes" 的对象，否则返回 NULL 。

例子

gVigns <- pkgVignettes("grid")
str(gVigns)