删除roxygen标签/部分

时间:2015-09-04 15:09:34

标签: r roxygen2

我正在定义一个具有属性的函数:

#' Some function
f = structure(function (n) n * 2, class = 'foo')

不幸的是,Roxygen会生成一份文档,如下所示:

Description:

     Some function

Usage:

     f

Format:

     function (n)  
      - attr(*, "srcref")=Class 'srcref'  atomic [1:8] 7 19 7 36 19 36 7 7
       .. ..- attr(*, "srcfile")=Classes 'srcfilecopy', 'srcfile' <environment: 0x7fb88cc395c0> 
      - attr(*, "class")= chr "foo"

我可以通过手动指定其他@usage来修复“使用情况”块。但是,我还想摆脱“格式”块。我能达到的最好效果是通过在Roxygen注释中指定@format .(或类似)来使其不那么显眼。我怎样才能完全删除它?

顺便说一下,如果我正常定义函数并稍后添加属性就没有区别。

1 个答案:

答案 0 :(得分:1)

使用@format NULL删除格式块。