Question

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

我有一个包含3个元素（data.frames）的列表，每个数据框都有一些列。我想知道如何在roxygen2中记录这个层次结构（list - ＆gt; data.frame - ＆gt;列）。这些示例始终只显示一个图层，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.frame都与id列相关联，因此它们有点相关，但我不想将它们放在一个数据帧中，因为它节省了内存。 / p>

欢迎任何建议。

修改

我尝试在我的文档中添加片段，但这似乎不起作用

#' 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个参数。

还有其他建议吗？

Answer 1

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

#' 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。但是这个解决方案目前有效。

使用roxygen2记录数据帧列表

1 个答案: