ヘルパー関数のドキュメントを隠すにはどうしたらいいですか？

Question

私は、.rdファイルで文書化されたいくつかのヘルパー関数を持つパッケージを維持しています。エクスポートされていないため、ユーザーが簡単にアクセスできません。これは良いことです。ただし、パッケージヘルプファイルの索引にはまだ表示されています。

それを乱雑にしないようにインデックスから削除文書を持ってする方法はありますが、それでもアクセス可能help経由の？

Answer 1

keywordsという名前の追加可能なフィールドがあります。ほとんどのキーワードは、1つの注目すべき例外を持つ関数を検索するのに役立つ以外は何もしません。internal内部キーワードを使用して関数にマークを付けると、索引から削除されます。 roxygen2 vignette：

@keywords keyword1 keyword2 ...標準化されたキーワードを追加します。キーワードはオプションですが、存在する場合はキーワードビネットに複製された事前定義リストから取得する必要があります。キーワードは@keywords internalを除いてあまり有用ではありません。 internalキーワードを使用すると、関連付けられた.Rdファイル内のすべての関数がドキュメントインデックスから削除され、自動テストの一部が無効になります。一般的な使用例は、（@exportを使用して）関数をエクスポートし、それを内部としてマークすることです。こうすることで、上級ユーザーは、新規ユーザーが混乱する可能性のある関数にアクセスすることができます。

@keywords internalをroxygenコメントに追加すると、望ましい結果が得られます。