私は機能のパッケージを持っています。 1つのファンクションには22個のパラメータ(...
を含む)があります。私は最近、パラメータを...
オプションから完全なパラメータに移動しました。それは、関数パラメータリストの論理的順序で記述されていても、roxygen2 @paramsアイテムリストの同じ順序で記述されていても、 document()
、新しいアイテムは下部の...
アイテムの下にあり、それ自体、論理的な場所にもある別のパラメータが続きます。Rパッケージドキュメントアイテムparams order
#' @param ParameterA does something
#' @param ParameterB does something else
#' @param ... optional extras
foo <- function(ParameterA, ParameterB, ...)
このような
Rdの&ヘルプファイルを見て:スクリプトは次のようになります。
例
Arguments
Parameter A does something
... optional extras
Parameter B does something else
私は、これはささいである知っているが、誰もがこの問題を解決する方法を知っていますか?私は.Rdファイルを削除し、document()
を無駄にしました。
Imgurアルバム(3枚の写真):http://imgur.com/a/pUX4m
編集:もっと掘り:私は、&リロードを構築チェックして、のこぎり走っ:
Documented arguments not in \usage in documentation object 'gbm.auto':‘tc’ ‘mapshape’.
Functions with \usage entries need to have the appropriate \alias entries, and all their arguments documented.
The \usage entries must correspond to syntactically valid R code.
最終段落の "RC" hereが言う前に、 @usage
は必要ありません。なぜなら、roxygen2のv3がこれを自動的に生成するからです。しかしこれは過去に働いていたにもかかわらず、私のためにもう働かない。
実行している一連のコマンドはなんですか?これはRStudioですべて起こっていますか?この問題を簡単に[再現可能]にすることができれば(http://stackoverflow.com/questions/5963269/how-to-make-a-great-r-reproducible-example)、あなたを助けるのがより簡単になるでしょう – MrFlick
こんにちは、すべてRstudio、そうです。本当に簡単には再現できません。私が理解しているように、特定の順序であなたのroxgyen2アイテムがあれば、document()はそれらを同じ順序で.Rdドキュメントにプッシュします。私の変更は単に何らかの形で書かれていない可能性があります。メインの質問にスクリーンショットが追加されました。 –
スクリーンショットは重要なビットをカットするのであまり役に立ちません。私はあなたの質問の例が正確ではないと推測しています。 [このコードの更新](https://github.com/krlmlr/roxygen/commit/89e3448b728654d236deb32ba94fc63797a1d3b5)によれば、パラメータの順序は、関数の定義順ではなく、関数の定義順で表示される順序にする必要があります。 @param属性 – MrFlick