使用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版本就是一个很好的例子.

我将在此描述未来溢流器的过程.

使用带有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包,看看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