使用 roxygen2 忽略腳本

Question

我正在編寫一個 package，它在服務器上做了一些工作。 我有一個更新表格的腳本，但我的意圖不是手動和不頻繁地運行它。 這不是 function 需要 go 進入命名空間或任何東西，只是一個腳本。

問題是，當我調用roxygen2::roxygenize()時，它會運行此腳本並需要一段時間才能運行，這在我嘗試開發交互式功能時非常煩人。 我知道我可以在文檔中的示例周圍添加\donotrun{} ，但這在這種情況下不太有意義。 有沒有辦法告訴 roxygen 不要費心執行這個？

我考慮將其設為 function 以便執行它只會定義 function 主體，但這似乎有點橫向。

任何建議都會很棒

Answer 1

對於新訪問者，這不是 function 的 roxygen 文檔中的代碼； 為此，最好用\donotrun將其包圍，如

#' @examples
#' \donotrun{
#' something_goes_here()
#' }
myfunction <- function(...) {

但是，在這種情況下，它包含 package 本身中的一些文件。

1. 您放置在./inst/目錄中的文件與軟件包一起安裝，但不假定它們是 R 腳本（或其他任何東西）。 對此的權威參考開始於“編寫 R 擴展” ， 第 1.1.5 節 Package 子目錄。 這將在通過install.packages(...)安裝 package 的每台計算機上安裝文件。

2. If you want something within the package source but not to be installed with the package itself, I suggest you place a file in the root of the package named .Rbuildignore (ref: same link, now section 1.3.2 Building package tarballs). 與這些模式匹配的文件不會包含在 package tarball 中。 是否將實際文件放在./inst/或其他任何地方完全取決於您：如果它位於.Rbuildignore文件中，那么它將從 tarball 中排除（因此最終用戶可以看到/找到）。