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 擴展”手冊。