使用 roxygen2 在單個文檔對象中記錄多個數據集

Question

我正在尋找等效的@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將文檔頁面與數據對象相關聯，但沒有引用使用部分中的對象 - 但我相信有更合適的方法來做到這一點？

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"

Answer 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"