我正在尝试创建我的第一个R包。谷歌,但我的问题没有具体提出。
在roxygen手册中它说
@family系列名称自动在系列中的所有功能之间添加see-also交叉引用。一个函数可以属于多个 家庭。
如何访问我的函数系列beloning?在添加我的@family text
后的文档中没有显示任何内容......
答案 0 :(得分:2)
从哈德利的书中,@family
应该是复数。
如果您有一系列相关功能,其中每个功能都应链接到该系列中的其他所有功能,请使用@family。 @family的值应该是复数。
您可能需要显示@family text
,而不是@family some text
。
此外,应将相同的@family
标记添加到多个函数中。例如,在devtools
包中,一些函数?devtools::dev-example
和?devtools::run-examples
具有标记
#' @family example functions
另请参阅部分包含彼此的链接