パッケージをいじり始めたばかりでroxygen
、これまでの結果に非常に満足しています。しかし、私は疑問に思っていましたroxygen
が、ユーザーがアクセスできない特定の機能を無視するように指定する方法はありますか?
具体的には、パッケージでフック.Rd
を使用しているため、ファイルをポップアップ表示したくありません。.onLoad()
この関数はすでにbase
パッケージに文書化されているので、再文書化する理由はありません。
Well, I finally found and browsed the Roxygen-devel list at R-forge to see when this would be implemented, and it appears to already be in the version of Roxygen that is on CRAN. The key is to specify use.Rd2=TRUE
when calling roxygenize()
. Under this mode, Roxygen will skip creating documentation for any functions that are not preceded by Roxygen comments.
これは彼らのやることリストにあります-次のバージョンでは、roxygenドキュメントを持つ関数だけがmanファイルを作成します。
内部キーワードフィールド(つまり @keywords internal
)を使用して、ドキュメントから関数を削除し、経験豊富なユーザーのみが使用できるようにします。出典:roxygen2ビネット。