去除氧气 tag/section
Remove roxygen tag/section
我正在定义一个具有属性的函数:
#' 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 .
(或类似的)来让它不那么显眼。我怎样才能完全删除它?
顺便说一句,如果我正常定义函数并稍后添加属性,这没有什么区别。
使用@format NULL
删除格式块。
我正在定义一个具有属性的函数:
#' 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 .
(或类似的)来让它不那么显眼。我怎样才能完全删除它?
顺便说一句,如果我正常定义函数并稍后添加属性,这没有什么区别。
使用@format NULL
删除格式块。