質問
私はちょうどroxygen
パッケージで遊んで始めていると私は、これまでの結果に非常に満足しました。しかし、私が思っていた、それはユーザーがアクセスできない特定の機能を無視することをroxygen
に指定する方法はありますか?
具体的には、私はむしろ、私は私のパッケージに.Rd
フックを使用していますので、.onLoad()
ファイルがポップアップしていないと思います。理由は、それが再文書に私のためにありませんので、この機能は、すでにbase
パッケージに記載されています。
解決
まあ、私は最終的に発見し、 R-鍛造でRoxygen-develメーリングリストを閲覧しましたこれが実施される際に参照するには、すでにCRANにあるRoxygenのバージョンであるように思われます。キーはuse.Rd2=TRUE
を呼び出すときにroxygenize()
を指定することです。このモードでは、RoxygenはRoxygenコメントが先行されていない任意の関数のドキュメントを作成スキップします。
他のヒント
これは自分の行うには、リスト上にある - 次のバージョンでは、roxygenのドキュメントを持つ唯一の機能は、男のファイルを作成します。
を使用する内部キーワードフィールド(のすなわち。の@keywords internal
)のドキュメントから機能を削除し、経験のあるユーザのみのためにそれを利用できるようにします。
出典: roxygen2ビネットする
所属していません StackOverflow