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

Question

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

见这里：http://r-pkgs.had.co.nz/man.html ＆＃34;您可以将它们放在单独的文件中，并使用@example path / relative / to / packge / root将它们插入到文档中，而不是直接在文档中包含示例。＆＃34;

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

e.g。

#' 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

您的roxygen中使用的示例的适当位置是：

inst/examples/

那么氧气线应该是：

#' @example inst/examples/add.R

---

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

• 这使得在开发时更容易运行，修改和测试示例
• 这使得（原则上至少）可以在文档中的不同位置重用示例，例如在小插图中