R Package Doc (roxygen2) - 示例部分 - 执行示例

Question

我正在学习如何使用 roxygen2 创建 R 包和更具体的文档。

我正在使用我在网上某处找到的这个非常简单的示例：

#' Add together two numbers.
#' 
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1)
#' add(10, 1)
#' @export

add <- function(x, y) {
  x + y
}

但是当我运行 ?add 时我得到的是

Examples

add(1, 1)  
add(10, 1)

虽然我想要代码的结果：

Examples

add(1, 1)  
2  
add(10, 1)  
11

Answer 1

@examples部分的代码本来是按照写的执行的，实际上每次用R CMD check检查包都是运行（"Check Package" 在 R Studio 中）。因此，它不能包含这些命令的输出。

但是，正如@SymbolixAU 所写，您可以添加评论，例如：

#' Add together two numbers.
#' 
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1)
#' # 2
#'
#' add(10, 1)
#' # 11
#' @export
add <- function(x, y) {
  x + y
}

或者更确切地说：

#' Add together two numbers.
#' 
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @examples
#' add(1, 1) # returns 2
#'
#' add(10, 1) # returns 11
#' @export
add <- function(x, y) {
  x + y
}

R Package Doc (roxygen2) - 示例部分 - 执行示例

R Package Doc (roxygen2) - example part - execute example

r

documentation

package

roxygen2