當我開發 R package 時，如何讓自己擺脫 .Rd 文件

Question

我正在使用 R studio 1.2.1335 開發自己的 R package。 Within R folder of my package, I have function r2.R for which I did not build r2.rd file in man folder. 當我使用命令R CMD...檢查 packgae 時，我收到以下警告消息。

檢查缺少的文檔條目...警告未記錄的代碼對象：'r2' package 中的所有用戶級對象都應該有文檔條目。 請參閱“編寫 R”中的“編寫 R 文檔文件”一章

我該如何解決這個問題？

謝謝，

馬赫迪。

Answer 1

有幾種解決方案。

1. 不要導出r2 。 如果是內部 function，則不需要文檔。

2. 寫man/r2.Rd 。 運行prompt(r2)將為您提供文件的骨架版本，您可以將其編輯為真實版本。

3. 學習roxygen2語法，並將其放入您的.R 源代碼中。 它可以生成r2.Rd文件。

就個人而言，我一般做 1 或 2，但很多人似乎認為 3 更可取。 你的選擇。