在示例部分保留缩进

Question

Roxygen大大地简化了我的工作，而且在大多数情况下都非常友好和直观。但是有一件事我从来没有想明白，就是如何保留@examples部分的缩进，以便roxygenize("myPackage")的结果包含它。

#' @examples
#' sapply(1:10, function(i){
#'     x <- rbind(matrix(rnorm(20), 10, 2),
#'                matrix(rnorm(20), 10, 2) + i)
#'     myFunc(x)
#' }

会是

\examples{sapply(1:10, function(i){
    x <- rbind(matrix(rnorm(20), 10, 2),
               matrix(rnorm(20), 10, 2) + i)
    myFunc(x)
}}

替换成

\examples{sapply(1:10, function(i){
x <- rbind(matrix(rnorm(20), 10, 2),
matrix(rnorm(20), 10, 2) + i)
myFunc(x)
}}

这是一个小细节，但使得除了最简单的例子以外的所有内容都难以阅读，所以我很感激有人可以帮助我。

编辑：此错误已在较新版本的roxygen中得到纠正。

- Backlin

---

你是在使用 roxygen 还是 roxygen2？我非常确定这种情况不会发生在 roxygen2 中，如果确实发生了，那么这是一个 bug，应该进行报告。 - hadley

我之前一直使用普通的roxygen，但是在升级到roxygen2之后问题依旧存在。不过gsk3的解决方案对两个版本都有效，但我认为还是应该报告这个问题。我该怎么做呢？ - Backlin

请在 https://github.com/klutometis/roxygen/issues 提交一个可重现的错误报告。 - hadley

这里是 https://github.com/klutometis/roxygen/issues/27。 - Backlin

Answer 1

对于简短的示例而言，可能存在过多的开销。但是，对于较长的示例，您可以使用@example relative/path/to/example引入文件，这样应该可以正确缩进。

- Ari B. Friedman

---

谢谢，它的运行效果非常好！开销也不是很大，因为它只适用于一些偶尔出现的例子，特别是与手动更正缩进的巨大负担相比。 - Backlin