使用Roxygen2模板标记

Question

谁能提供一个如何在Roxygen2中正确使用模板标签的例子？我试着做(对我来说)最明显的事情：

在packageName-package.R文件中：

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

然后在某个Function.R文件中

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

我得到了错误：

 Error : Can not find template testTemplateTag

我尝试在一个地方记录通常重复的定义、示例等。当这些东西嵌套在一组函数中时，我一直在使用@inheritParms。但有些东西，比如定义和其他描述，在几个地方都会用到。我到处搜索@template和@templateVar的用法，没有找到任何东西。

谢谢。

Answer 1

太棒了！谢谢@hadley。plyr的GitHub版本就是一个很好的例子。

我将在这里描述这个过程，以供将来使用。

在Roxygen2中使用模板

1)你应该创建一个文件夹来存放你的模板：man-roxygen/

2)每个模板都是一个位于man-roxygen/中的.R文件

例如：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块中，您可以这样调用 of 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