7

1つを除いてまったく同じ引数を持つ2つの関数を含む小さなRパッケージを書いているとしましょう。以下に例を示します。

fct1 <- function(r, K){...}
fct2 <- function(r, p, K){...}

最初の関数の roxygen2 ドキュメントでは、次のタグを使用しています。

#' @param r description of argument r
#' @param K description of argument K

2 番目の関数では、次のタグを使用します。

#' @param p description of argument p
#' @inheritParams fct1

コードを roxygenize で処理した後、関数 fct2 の .Rd ファイルは次の順序で引数を示します: p、r、K。 p, K. .Rd ファイルを手動で変更せずにこの順序を取得するにはどうすればよいですか?

コピーと貼り付けを避けるために @inheritParams を使用することを主張します。

ありがとう！

4

1 に答える 1

2

私も同じ問題を抱えてる。今のところ、間違った引数の順序を避けるためにちょっとしたトリックを使用します。

コードを使用します (たとえば、別の .R ファイルで):

#' Function arguments
#'
#' @keywords integral
#'
#' @name fargs
#'
#' @param r ..
#' @param p ..
#' @param K ..
#' 
#' 
NULL

と使用

#' @inheritParams fargs

両方の機能に。

この場合は簡単でしたが、より複雑な例では、U はこのコードの多くのブロック (引数の型ごとに別のブロック) を使用できます。それほど単純な方法ではないかもしれませんが、同じコードをどこにも繰り返さないでください。そのブロックを別のargs.Rファイルに保存して、すべての継承引数が1つのファイルにあるようにします。

もう 1 つの方法はテンプレートを使用することですが、この方法は柔軟性がなく、ブロックごとに個別の .R ファイルを作成する必要があります。したがって、同様のコードブロックを使用することをお勧めします。

于 2014-12-05T15:51:40.337 に答える