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)