から関数を除外します。しかし、私はすべての機能がパッケージのマニュアルに表示されることを望んでいません。 パッケージマニュアルに表示する関数を指定するにはどうしたらよいですか？私はRパッケージを書いている、と私はroxygen2と私のすべての機能を文書化していRパッケージマニュアル
私は、例えば、先頭のドットを持つ関数に名前を付けることを承知していますf <- function()の代わりに.f <- function()が解決策です。他にも解決策はありますか？
私は（オブジェクトのドキュメントのセクションで）ハドレーウィッカムことにより、優れた著書R packagesで、次の詳細を逃した：
@keywords KEYWORD1 KEYWORD2 ...標準化されたキーワードを追加します。キーワードはオプションですが、存在する場合は、file.path（R.home（ "doc"）、 "KEYWORDS"）にある定義済みのリストから取得する必要があります。
は一般的に、キーワードは内部@keywordsを除いてその有用ではありません。 internalキーワードを使用すると、パッケージインデックスから機能が削除され、自動テストの一部が無効になります。 @keywords internalは、パッケージを拡張する他の開発者にとって関心のある機能ですが、ほとんどのユーザーにとっては関心がありません。だから、まだヘルプページがパッケージをロードした後アクセスできるようにしながら、パッケージのマニュアル/インデックスに表示されていない機能でroxygen2機能のドキュメント結果に
@keywords internalを追加
。
+1は '@keywords internal.'を探すためのものです。私は内部のヘルパー関数を持っている人を退屈にしたくありません。 – keberwein
マニュアルに記載したくない場合はなぜ文書化するのですか？ – nrussell
私はどちらの関数が何を思い出すのか、そして「隠された」関数を使いたい人にとっては役に立ちます。私はパッケージをインポートした後に '？function_name'をコンソールに書くことで、関数のヘルプページを見つけることができなかった他のパッケージの例を見たと思いますが、'？pkgname： :: function_name'。私は間違って覚えている可能性があります。 –
':::'でアクセスされる関数はパッケージからエクスポートされません。これは通常、クライアントが関数を使用するつもりはないということを意味します。一般に、このような機能は文書化されていません。 'tools :::。is_ASCII'です。ドキュメントを持っていないエクスポートされていない関数に遭遇した場合、以前はエクスポートされた（ドキュメント化された）関数であり、それ以降のバージョンでエクスポートのリストから削除された可能性が高いと思います。 – nrussell