如何访问R包函数的族属
How to access family belonging of R package function
我正在尝试创建我的第一个 R 包。 Google' 但没有针对我的问题提出任何具体问题。
roxygen 手册中说
@family family name Automatically adds see-also cross-references between all functions in a family. A function can belong to multiple
families.
如何访问我的函数家族归属感?在添加我的 @family text
后的文档中没有任何显示...
根据 Hadley 的书,@family
应该是复数形式。
If you have a family of related functions where every function should link to every other function in the family, use @family. The value of @family should be plural.
例如, 而不是 @family text
,您可能需要显示 @family some text
。
此外,相同的 @family
标签应该添加到多个函数中。例如,在 devtools
包中,几个函数 ?devtools::dev-example
和 ?devtools::run-examples
具有标签
#' @family example functions
另请参阅 部分具有相互链接
我正在尝试创建我的第一个 R 包。 Google' 但没有针对我的问题提出任何具体问题。
roxygen 手册中说
@family family name Automatically adds see-also cross-references between all functions in a family. A function can belong to multiple families.
如何访问我的函数家族归属感?在添加我的 @family text
后的文档中没有任何显示...
根据 Hadley 的书,@family
应该是复数形式。
例如,If you have a family of related functions where every function should link to every other function in the family, use @family. The value of @family should be plural.
而不是 @family text
,您可能需要显示 @family some text
。
此外,相同的 @family
标签应该添加到多个函数中。例如,在 devtools
包中,几个函数 ?devtools::dev-example
和 ?devtools::run-examples
具有标签
#' @family example functions
另请参阅 部分具有相互链接