使用 roxygen2 在单个文档对象中记录多个数据集

Question

我正在寻找相当于@describeIn它允许我为多个 R 数据对象创建单个文档对象。

\n\n

我本来希望这样的事情：

\n\n

#\' Tree Distances\n#\' \n#\' These datasets contain the distances between sets\n#\' of 10-tip, 11-tip and 12-tip trees.\n#\' \n#\' @name treeDistances\n#\' @keywords datasets\n"treeDistances10"\n"treeDistances11"\n"treeDistances12"\n

\n\n

将生成一个适用于所有三个treeDistances##对象的手册页，类似于使用@describeIn treeDistances Distances between 11-tip trees.

\n\n

我注意到添加@aliases treeDistance11 treeDistance12文档页面与数据对象相关联，但没有引用“使用”部分 \xe2\x80\x93 中的对象，但我相信有更合适的方法来执行此操作？

\n

Answer 1

使用@rdname：

#' Tree Distances
#' 
#' These datasets contain the distances between sets
#' of 10-tip, 11-tip and 12-tip trees.
#' @name treeDistances
#' @keywords datasets
"treeDistances10"

#' @rdname treeDistances
"treeDistances11"

#' @rdname treeDistances
"treeDistances12"