包名稱=主要功能名稱時的文檔

我正在編寫R包名稱slidify。包裝中的主要功能也被命名爲slidify。當我運行devtools::check時，出現Rd文件中存在衝突的警告。包名稱=主要功能名稱時的文檔

我不想重命名該函數，因爲它毫不猶豫地表達了該包的用途。這種情況下的最佳做法是什麼？應該輸入? slidify是否導致功能文檔或軟件包文檔？

任何想法將不勝感激。

2012-11-06 Ramnath

我會做一個「slidify-package.Rd」文件（或只是roxygen註釋塊「slidify-package.R」文件）

?slidify應導致函數文檔和slidify?package應導致包文檔，並幫助頁面應該有一個鏈接到另一個（例如seealso部分）

2012-11-06 15:49:06 GSee

謝謝。我已經有了帶有Roxygen樣式文檔的'package.R'文件。問題是我有一個'@alias slidingify'指令，這導致了問題。我刪除了它，現在在兩個地方都有'@ seealso'指令。感謝您的建議。 – Ramnath

我想你的意思是'包裝？滑動' – hadley

@hadley，heh。謝謝。我沒有意識到這種語法。 – GSee

回答