從R包手冊中排除功能

Question

我正在寫一個R包，我正在用roxygen2記錄我的所有函數。 但是，我不希望所有功能都出現在軟件包的手冊中。 如何指定應在包裝手冊中顯示哪些功能，或哪些不應該？

我知道命名一個帶有前導點的函數，例如.f <- function()而不是f <- function()是一個解決方案。 還有其他解決方案嗎？

Answer 1

我在Hadley Wickham的優秀書籍R包中錯過了以下細節（在對象文檔部分）：

@keywords keyword1 keyword2 ...添加標准化關鍵字。 關鍵字是可選的，但如果存在，則必須從file.path（R.home（“doc”），“KEYWORDS”）中找到的預定義列表中獲取。

通常，除了@keywords internal之外，關鍵字沒有那么有用。 使用internal關鍵字將從包索引中刪除該功能，並禁用其一些自動測試。 將@keywords內部用於擴展您的軟件包的其他開發人員感興趣的功能是常見的，但不是大多數用戶。

因此，在roxygen2函數文檔中添加@keywords internal導致該函數不會出現在包手冊/索引中，同時仍然可以在加載包后訪問幫助頁面。