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

Posted 2023-03-12

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

【英文标题】：Use roxygen2 to document multiple datasets in a single documentation object

【发布时间】：2019-12-14 20:25:52

【问题描述】：

我正在寻找 @describeIn 的等效项，它允许我为多个 R 数据对象创建单个文档对象。

我曾希望是这样的：

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

将生成一个适用于所有三个treeDistances## 对象的手册页，类似于使用@describeIn treeDistances Distances between 11-tip trees 在另一个函数中描述一个函数。

我注意到添加 @aliases treeDistance11 treeDistance12 会将文档页面与数据对象相关联，但没有引用“使用”部分中的对象 - 但我相信有更合适的方法来做到这一点？

【问题讨论】：

r-pkgs.had.co.nz/man.html#multiple-man

【参考方案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"

【参考方案2】：

按照 antoine-sac 的链接到 r-pkgs.had.co.nz/man.html#multiple-man，正确的格式是：

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

#' @rdname treeDistances
"treeDistances10"
#' @rdname treeDistances
"treeDistances11"
#' @rdname treeDistances
"treeDistances12"

【讨论】：

你可以直接记录第一个数据集，不需要NULL，除非你喜欢它，看我的回答:)