R checkVignettes 檢查包裝插圖

說明

通過在包上運行Sweave(或其他自定義編織函數)和/或Stangle(或其他自定義纏結函數)來檢查包的所有小插圖。在纏結步驟之後找到的所有 R 源代碼文件都經過 source 編輯，以檢查所有代碼是否可以無錯誤地執行。

用法

checkVignettes(package, dir, lib.loc = NULL,
               tangle = TRUE, weave = TRUE, latex = FALSE,
               workdir = c("tmp", "src", "cur"),
               keepfiles = FALSE)

參數

package	命名已安裝包的字符串。如果給定，則在子目錄‘中查找暈影源文件文檔’。
dir	指定包根源目錄路徑的字符串。如果給定，則在子目錄‘中查找暈影源文件小插圖’。
lib.loc	目錄名稱的字符向量R Library ，或NULL.默認值為NULL對應於當前已知的所有庫。指定的庫樹用於搜索package.
tangle	與source提取的代碼進行糾纏？
weave	進行編織？
latex	邏輯：如果weave和latex是TRUE並且沒有‘生成文件' 在vignettes目錄中，運行中間'.tex' 編織的輸出texi2pdf.
workdir	檢查小插圖時用作工作目錄的目錄。如果"tmp"然後創建一個臨時目錄，這是默認的。如果"src"然後使用包含小插圖本身的目錄，如果"cur"那麽當前的工作目錄R被使用。

keepfiles

刪除臨時目錄中的文件？當 workdir != "tmp" 時，此選項將被忽略。

細節

此函數首先使用 pkgVignettes 查找包小插圖，特別是它們的小插圖引擎(請參閱 vignetteEngine )。

如果tangle為 true，然後運行Stangle(或引擎提供的其他自定義纏結函數)來生成(一個或多個)R每個小插圖中的代碼文件，然後source依次讀取每個代碼文件。

如果weave是真的，這些小插曲都貫穿了Sweave(或引擎提供的其他自定義編織函數)。如果latex也是如此，並且不存在‘生成文件' 在小插圖目錄中，texi2pdf在中間運行'.tex' 來自編織的那些在前麵的步驟中沒有給出錯誤的小插圖的文件。

值

"checkVignettes" 類的對象，它是一個列表，其中包含在纏結、源、編織和乳膠步驟期間發現的錯誤消息。有一個 print 方法用於顯示此類對象中包含的信息。