r - 为数据框自动生成 roxygen2 文档的最佳方法是什么？

Question

在我的新 CRAN 包中，我有 10 个数据框，在 data/文件夹中每种类型都有 10 列左右。类型有字符串、整数、 float 、 bool 值等。

我需要为每个数据源添加 roxygen2 文档。有没有一种方法可以在给定 data.frame 的情况下自动生成评论 block ？

类似:makeDocs(games)

#' games
#'  title character
#'  score integer
#'  value numeric
#'  ...

我担心如果我手动执行，我可能会出错(大约 100 列)，或者如果名称发生变化，我会不断地手动重新编辑内容。

我找到了这个关于记录数据集的好答案 How can I document data sets with roxygen?

...但这并没有解决我如何自动生成这些评论？

Answer 1

您很可能会发现 sinew R-package 提供的功能很有用；请参阅 here 中的 R-bloggers 帖子中提供的示例.

以下示例适用于数据帧和函数，并为它们创建 roxygen 骨架。您自然需要手动修改一些字段，如大写字母所示:

> set.seed(1); dat <- data.frame(first = LETTERS[1:10], second = rnorm(10), third = 1:10)
> fun <- function(x, y) { x + y }
> sinew::makeOxygen(dat)
#' @title DATASET_TITLE
#' @description DATASET_DESCRIPTION
#' @format A data frame with 10 rows and 3 variables:
#' \describe{
#'   \item{\code{first}}{character COLUMN_DESCRIPTION}
#'   \item{\code{second}}{double COLUMN_DESCRIPTION}
#'   \item{\code{third}}{integer COLUMN_DESCRIPTION} 
#'}
#' @details DETAILS
"dat"
> sinew::makeOxygen(fun)
#' @title FUNCTION_TITLE
#' @description FUNCTION_DESCRIPTION
#' @param x PARAM_DESCRIPTION
#' @param y PARAM_DESCRIPTION
#' @return OUTPUT_DESCRIPTION
#' @details DETAILS
#' @examples 
#' \dontrun{
#' if(interactive()){
#'  #EXAMPLE1
#'  }
#' }
#' @rdname fun
#' @export

如您所见，sinew 生成 #'-行，当放置在适当的位置时，这些行与生成 roxygenized .Rd 文件兼容在 .R 文件中。查看包中可以将这些线自动放置到正确位置的更多功能。