roxygen2如何不運行示例文件

Question

當代碼直接在roxygen注釋中時，我很清楚如何讓roxygen不運行示例。 但是，某些示例可能有點冗長，或者您希望在示例目錄中編譯示例。 在這種情況下@example file_path工作正常，但我無法弄清楚如何讓roxygen不運行（即\\dontrun ）示例文件 。

這被認為與這個問題非常相似，但評論顯示這個問題沒有得到解答。

test.R

# this does not work
#' @title test_fun
#' @example \dontrun{examples/test_example.R}
test <- function(){
    print("hello")
}

# this does
#' @title test
#' @examples 
#' \dontrun{
#' test()
#' }
test <- function(){
    print("hello")
}

test_example.R

test()

我怎樣才能讓前一種方法起作用？

Answer 1

看來我可以通過對示例文件中的\\dontrun{}塊使用roxygen2樣式的注釋來實現這一點。 這解決了Michal答案的限制。

創建一個如下所示的示例文件：

#' \dontrun{
test()
#' }

---

更可靠的是，您可以將示例包裝在if(interactive()) {}塊中，該塊在檢查期間不會運行，但允許您手動運行示例。

Answer 2

我認為如果您只是將\\dontrun test_example.R添加到示例腳本中，那么您的test_example.R將如下所示：

\dontrun{
test()
}

即使現在示例腳本不能直接source d，因為\\dontrun不是R表達式...