R buildVignette 构建一个小插图

说明

在一个小插图上运行 Sweave (或其他自定义编织函数)、 texi2pdf 和/或 Stangle (或其他自定义缠结函数)。

这是 R CMD Sweave 的主力。

用法

buildVignette(file, dir = ".", weave = TRUE, latex = TRUE, tangle = TRUE, 
              quiet = TRUE, clean = TRUE, keep = character(),
              engine = NULL, buildPkg = NULL, encoding, ...)

参数

file	特点;小插图源文件。
dir	特点;将在其中生成中间文件和输出文件的工作目录。
weave	逻辑性；应该运行编织吗？
latex	逻辑性；应该tools texi2dvi如果编织产生‘.tex' 文件？
tangle	逻辑性；应该运行缠结吗？
quiet	逻辑性；以安静模式运行？
clean	逻辑性；是否删除一些新创建的(通常是中间的)文件。请参阅下面的详细信息。
keep	清理时无论如何都要保留的文件名列表。请注意，“target” 文件无论如何都会保留。
engine	NULL或性格；要使用的晕影引擎的名称。覆盖任何‘⁠\VignetteEngine{}⁠' 小插图中的标记。
buildPkg	NULL 或字符向量；在其中查找晕影引擎的可选包。
encoding	文件的编码。如果未指定，则尽可能从文件内容中读取。请注意，如果插图是包的一部分，buildVignettes从'读取包的编码DESCRIPTION’ 文件，但此函数没有。
...	传递给 weave 和 tangle 的附加参数。

细节

该函数确定晕影的晕影引擎(默认utils::Sweave)，然后使用该引擎编织和/或缠结小插图。最后，如果clean是TRUE，新创建的中间文件(非“targets”，这些文件取决于引擎等，而不是任何keep)将被删除。如果clean是NA， 和weave为 true，则新创建的中间输出文件(例如，‘.tex’) 即使‘.pdf’ 文件已由它们生成。

如果buildPkg指定后，这些包将在处理 vignette 之前加载，并将用作搜索 vignette 引擎的默认包，但在 vignette 源中明确指定的包(例如，使用‘⁠\VignetteEngine{utils::Sweave}⁠’来指定Sweave发动机在utils包)将覆盖它。相反，如果engine给出参数，它将覆盖晕影源。

值

命名已生成的文件的字符向量。

作者

Henrik Bengtsson and Duncan Murdoch

也可以看看

buildVignettes 用于构建包中的所有小插图。