R 包构建：如何在记录要包含在我的 R 包中的数据时修改 @source 行

Question

我正在尝试将数据包含在我刚刚构建的包中，我包含了如下数据对象：

set.seed(289805)
x <- room(10, mean = 0, var = 1)

我从 This Page 那里得到了帮助，在那里我得到了要修改的代码示例。以下是存储在 data.R 的 \R 文件夹中的文档术语：

#' Prices of 50,000 round cut diamonds.
#'
#' A dataset containing the prices and other attributes of almost 54,000
#' diamonds.
#'
#' @format A data frame with 53940 rows and 10 variables:
#' \describe{
#'   \item{price}{price, in US dollars}
#'   \item{carat}{weight of the diamond, in carats}
#'   ...
#' }
#' @source \url{http://www.diamondse.info/}
"diamonds"

因为我的数据不是来自任何网址，所以我想我不能使用 \url{}。我使用的数据是这样的模拟数据：

set.seed(289805)
x <- room(10, mean = 0, var = 1)

我想要的

我将在 #' @source \url{http://www.diamondse.info/} 行中使用什么代替 \url{}？

Answer 1

希望您现在已经找到了解决方案。我运行遇到了同样的问题。

我发现 @source 是 roxygen2 code that gets converted to Rd documentation. Along the way I found R-Bloggers 对 Rd 文档的 \source 术语的描述，他们在其中使用“合成”来描述其数据源。

据我所知，这只是一个用于描述数据来源的文本字段。 \url markup 只是帮助格式化。在你的情况下，我会使用类似的东西：

#' @source Simulated data generated with the following code:
#'   set.seed(289805)
#'   x <- room(10, mean = 0, var = 1)

R 包构建：如何在记录要包含在我的 R 包中的数据时修改 @source 行

R-Package Building: How to Modify @source Line While Documenting Data to be Included in My R Package

r

r-package