使用roxygen2记录数据帧列表

我正试图记录我在包中附加的一些数据

我有一个包含3个元素（data.frames）的列表，每个数据帧都有一些列。我想知道如何在

roxygen2

中记录这种层次结构（list->data.frame->column）。示例始终仅显示一个图层，即data.frame，然后显示列名。下面是一个列表中包含两个数据帧的最小示例

list(
  names=data.frame(id=1:10, a=letters[1:10]),
  values=data.frame(id=rep(1:10, each=10), values=runif(100))
)

在我的列表中，所有三个data.frames都与

id

列连接，因此它们有点相关，但我不想将它们放在一个数据帧中，因为这样可以节省内存

欢迎提出任何建议

编辑

我试图向文档中添加段，但这似乎不起作用

#' List with group information for the test data set
#'
#' This dataset is a list with 2 data.tables (proteins, timepoint). 
#' It has a common id column in all data.tables.
#'
#' \strong{proteins}
#' @format A data frame with 5458 rows and 3 columns
#' \describe{
#'   \item{id}{unique group id}
#'   \item{names}{individual names}
#'   \item{other names}{other names}
#' }
#'
#' \strong{timepoint}
#' @format A data frame with 80248 rows and 5 columns
#' \describe{
#'   \item{id}{unique group id}
#'   \item{timepoint}{individual timepoint}
#'   \item{imputed_mean}{mean value including imputed values}
#'   \item{measured_mean}{mean value without imputing (contains NAs)}
#'   \item{value_count}{number of measured values within the replicates}
#' }
'pg_test'

输出看起来只能处理1个

@format

参数

---

还有其他建议吗？

事实上，我刚刚想出了一个解决方案，只要没有其他人有更好的建议

#' List with group information for the test data set
#'
#' This dataset is a list with 2 data.tables (proteins, timepoint). 
#' It has a common id column in all data.tables.
#'
#' @format 
#' \enumerate{
#' \item \strong{proteins} A data frame with 5458 rows and 3 columns
#' \describe{
#'   \item{id}{unique group id}
#'   \item{names}{individual names}
#'   \item{other names}{other names}
#' }
#'
#' \item \strong{timepoint} A data frame with 80248 rows and 5 columns
#' \describe{
#'   \item{id}{unique group id}
#'   \item{timepoint}{individual timepoint}
#'   \item{imputed_mean}{mean value including imputed values}
#'   \item{measured_mean}{mean value without imputing (contains NAs)}
#'   \item{value_count}{number of measured values within the replicates}
#' }
#' }
'pg_test'

也可以通过以下方式解决：

#' \describe{
#'   \item{One}{First item}
....

我想应该用枚举代替

\enumerate

。但这个解决方案目前还有效