R vignetteEngine 设置或获取晕影处理引擎

说明

小插图通常由Sweave，但包编写者可以选择使用不同的引擎(例如，由knitr,noweb或者R.rsp包)。这些包使用此函数来注册其引擎，并在内部由R来找回它们。

用法

vignetteEngine(name, weave, tangle, pattern = NULL,
	       package = NULL, aspell = list())

参数

name	发动机的名称。
weave	将晕影源文件转换为 PDF/HTML 或中间 LaTeX 输出的函数。
tangle	将小插图源文件转换为的函数R代码。
pattern	该引擎处理的文件名的正则表达式模式，或默认模式的NULL。
package	注册引擎的包。默认情况下，这是调用 vignetteEngine 的包。
aspell	元素名称为 filter 和/或 control 的列表，给出在使用 aspell 对晕影源文件中的文本进行拼写检查时要使用的相应参数。

细节

如果 weave 缺失，vignetteEngine 将返回当前注册的匹配 name 和 package 的引擎。

如果 weave 为 NULL ，则指定的引擎将被删除。

其他设置定义了新引擎。 weave 和 tangle 函数必须使用与 function(file, ...) 兼容的参数列表进行定义。目前...参数可以包括逻辑参数quiet和字符参数encoding；将来可能会添加其他内容。这些在 Sweave 和 Stangle 的文档中进行了说明。

weave和tangle函数应返回已生成的输出文件的文件名。目前weave函数，当对名为‘的文件进行操作时<名称><模式>' 必须生成一个名为 '<名称>[.](tex|pdf|html)’。这 '.tex' 文件将被处理pdflatex生产 '.pdf’ 输出显示给用户；其他的将按生产状态显示。这tangle函数必须生成一个名为‘<名称>[.][rRsS]' 包含可执行文件R小插图中的代码。这tangle函数可能支持split = TRUE参数，然后它应该生成名为“<名称>.*[.][rRsS]’。

pattern 参数提供一个正则表达式来匹配要作为晕影输入文件处理的文件的扩展名。如果设置为 NULL ，则使用默认模式 "[.][RrSs](nw|tex)$"。

值

如果正在删除引擎，则 NULL 。否则包含组件的列表

name	发动机名称
package	其包的名称
pattern	小插图输入文件的模式
weave	编织函数
tangle	缠结函数

例子

str(vignetteEngine("Sweave"))

作者

Duncan Murdoch and Henrik Bengtsson.

也可以看看

Sweave 和“编写 R 扩展”手册。