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（R Studio中的“Check Package”）检查包时都会运行它。因此，它不能包含这些命令的输出。

但是，正如@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） - 示例部分 - 执行示例

1 个答案: