7

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 中得到了纠正。

4

1 回答 1

4

简短的示例可能开销太大,但对于较长的示例,您可以@example relative/path/to/example拉入一个文件,这应该可以正确缩进。

于 2011-08-08T14:31:55.113 回答