使用 roxygen2 记录包

用 roxygen2 写

roxygen2 是 Hadley Wickham 为方便文档而创建的软件包。

它允许在由 #'开始的行中包含 R 脚本中的文档。传递给文档的不同参数以 @ 开头，例如包的创建者将按如下方式编写：

#' @author The Author

例如，如果我们想要记录以下函数：

mean<-function(x) sum(x)/length(x)

我们将要为此函数编写一个小描述，并用以下内容解释参数（每行将在后面解释和详述）：

#' Mean
#'
#' A function to compute the mean of a vector
#' @param x A numeric vector
#' @keyword mean
#' @importFrom base sum
#' @export
#' @examples
#' mean(1:3)
#' \dontrun{ mean(1:1e99) }
mean<-function(x) sum(x)/length(x)

• 第一行 #' Mean 是文档的标题，以下行是语料库。
• 必须通过相关的 @param 详细说明函数的每个参数。@export 表示应该导出此函数名，因此可以在加载包时调用。
• @keyword 在寻求帮助时提供相关的关键字
• @importFrom 列出了要从将在此函数或你的包中使用的包导入的所有函数。请注意，可以使用 @import 完成导入包的完整命名空间
• 然后将示例写在 @example 标记下面。
  • 在构建包时将评估第一个;
  • 由于\dontrun 命令，第二个不会 - 通常是为了防止长时间的计算。

构建文档

可以使用 devtools::document() 创建文档。另请注意，devtools::check() 将自动创建文档，并将函数文档中缺少的参数报告为警告。