r - 使用 Roxygen2 模板标签

Question

有人可以提供一个如何正确使用 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

我试图有一个地方来记录常见的重复定义示例等。当这些东西嵌套在我一直在使用的一组函数中时 @inheritParms .但是有些东西，如定义和其他描述，在几个地方使用。我搜索了 @template 的使用情况。和 @templateVar并没有发现任何东西。

谢谢。

Answer 1

完美的!谢谢@hadley。 plyr 的 GitHub 版本就是一个完美的例子。

我将在这里为 future 的溢出者描述这个过程。

在 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 中的所有内容文件。

查看 plyr package on GitHub看看 Hadley 使用存储在 man-roxygen\ 中的多个模板文件的巧妙方式他可以混合搭配来创建文档。查看以下内容以了解此想法:

寻找 @template 的用途在这些文件中:

 R/aaply.r
 R/adply.r

看看这里的模板:

 man-roxygen/ply.r
 man-roxygen/a-.r
 man-roxygen/-a.r
 man-roxygen/-d.r