Roxygen2のコレートの順序はどうすればわかりますか？

devtools documentでroxygen2のドキュメントを使用すると、特定の順序でパッケージライブラリファイルをロードする必要があるかどうかにかかわらず、パッケージDESCRIPTIONにCollate:フィールドが自動的に生成されます。Roxygen2のコレートの順序はどうすればわかりますか？

私はたくさんのS4メソッドを使ってパッケージを作成していますが、それらのメソッドやクラスを使用する前にクラス定義がロードされていることを確認したいのですが、Collateリストでは、これをroxygen2のドキュメント形式で示す方法がわかりません。

は@includeタグを参照していますが、実際には@examplesフラグを使用して外部の例を追加するなど、実際にはドキュメントにコードを含めるように見えます。メソッドの照合順序を指定するために使用できますか？

出典

2013-08-31 cboettig

でそれに従っていない限り、それは次のroxygen2のドキュメントブロックに干渉することを考え出しましたフィールドはすでに説明にあります.roxygen2はそれを生成しません。だから、あなたが望む秩序を作らなければならず、尊敬すべきだと言いたい。（私は思う、したがって、コメントと答え）。 –

私の@import解釈が正しいかどうかは知っているといいでしょう。また、ファイルの依存関係のリストから照合順を手動で取り出すのではなく、機能を把握することも可能です。 – cboettig

インポートはパッケージをインポートするために使用されます。これは、Dependsセクションのパッケージをリストするのと似ていますが、パッケージがユーザーの名前空間を汚染しないので、はるかにクリーンです。 – Dason

includeタグは、1つのファイルが別のファイルで動作する必要があることを示すために使用されます。（名前が含まれているのは最良の選択肢ではなかったかもしれませんが、そのような人生です）。ファイルAの前にファイルBがロードされていることを確認したい場合は、Aの@include Bを必ず確認してください。制限を満たすために、Roxygenは照合フィールドを注文します。

出典

2013-09-03 14:07:23 hadley

華麗なので、私は必要なものだけを含んでいます！ – cboettig

私はちょうどあなたがあなたのRファイルの先頭に@includeのステートメントを追加した場合、コレート場合は、NULL、たとえば

#' @include something.R 
NULL 

#' Documenting a function 
#' 
#" It does something... 
#' 
#' @param ... 
#'

出典

2014-02-26 18:56:26 THK

Roxygen2のコレートの順序はどうすればわかりますか？

答えて

関連する問題