r - パッケージ名 = メイン関数名の場合のドキュメント

Question

Rパッケージ名を書いていますslidify。パッケージ内のメイン関数の名前もslidify. を実行するdevtools::checkと、Rd ファイルに競合があるという警告が表示されます。

パッケージの目的を簡潔に伝えるため、関数の名前を変更したくありません。この状況でのベストプラクティスは何ですか? 入力? slidifyすると、関数のドキュメントまたはパッケージのドキュメントにつながる必要がありますか?

任意の考えをいただければ幸いです。

Answer 1

「slideify-package.Rd」ファイル (または、roxygen コメント ブロックのみを含む「slideify-package.R」ファイル) を作成します。

?slidify関数のドキュメントとslidify?packageパッケージのドキュメントにつながる必要があり、両方のヘルプ ページに他のページへのリンクが必要です (たとえば、seealso セクション内)。