27

誰かがでテンプレートタグを適切に使用する方法の例を提供できますかRoxygen2。私は（私にとって）最も明白なことをしようとしました：

私のpackageName-package.Rファイル：

 #' [... other Roxygen blocks ...]
 #' 
 #' @templateVar testTemplateTag Testing one two
 NULL

次に、ファイルでsomeFunction.R

 #' [... other Roxygen blocks ...]
 #'
 #' @template testTemplateTag

エラーが発生します：

 Error : Can not find template testTemplateTag

私は、一般的に繰り返される定義の例などを文書化するための1つの場所を作ろうとしています。これらのものが一連の関数内にネストされている場合、私は使用してい@inheritParmsます。しかし、定義やその他の説明など、いくつかの場所で使用されています。@templateとの使用法を高低で検索しましたが、@templateVar何も見つかりませんでした。

ありがとう。

4

1 に答える 1

41

完全！@hadleyに感謝します。plyrのGitHubバージョンは完璧な例でした。

ここでは、将来のオーバーフローのプロセスについて説明します。

Roxygen2でのテンプレートの使用

1）テンプレートを保持するフォルダーを作成する必要があります。man-roxygen/

2）各テンプレートはに存在する.Rファイルですman-roxygen/

例えば：man-roxygen/someTemplate.R

 #' ... [other roxygen2 tags and information] ...
 #'
 #' @param someParm A parameter that is used in several functions.
 #'
 #' ... [more roxygen2 tags and information] ...

3）他のブロックでは、この方法ですべてのコードroxygen2を呼び出すことができます。roxygen2

 #' ... [other roxygen2 tags and information] ...
 #'
 #' @template someTemplate

4）テンプレートを使用すると、ファイル内のすべてが取得されsomeTemplate.Rます。

GitHubのplyrパッケージをチェックして、 Hadleyman-roxygen\がドキュメントを作成するために組み合わせることができるいくつかのテンプレートファイルを使用する巧妙な方法を確認してください。アイデアを得るために以下を見てください：

@templateこれらのファイルでの使用を探してください：

 R/aaply.r
 R/adply.r

ここでテンプレートを見てください：

 man-roxygen/ply.r
 man-roxygen/a-.r
 man-roxygen/-a.r
 man-roxygen/-d.r
于 2013-02-28T18:59:52.760 に答える