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 用於構建包中的所有小插圖。