r - 将@example标记与roxygen2一起使用时的文件位置

Question

用roxygen2记录功能时，可以将示例放在单独的文件中。

看到这里:http://r-pkgs.had.co.nz/man.html
“您可以将示例放在单独的文件中，而不必将其直接包含在文档中，而可以使用@example path/relative/to/packge/root将其插入文档中。”

在这里:http://roxygen.org/roxygen2-manual.pdf

例如

#' Add together two numbers.
#' 
#' @param x A number.
#' @param y A number.
#' @return The sum of \code{x} and \code{y}.
#' @example /path/to/example/add.R
add <- function(x, y) {
  x + y
}

我的问题是:应该使用什么路径来存储示例R文件？

Answer 1

氧气中使用的示例的适当位置是:

inst/examples/

氧气线应为:

#' @example inst/examples/add.R

这是好习惯吗？我认为是这样，因为:

在开发

时可以更轻松地运行，修改和测试示例

使得(至少在原则上)可以在文档的不同位置重用示例，例如在小插图

中