在示例部分中保留缩进
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中得到纠正。
简短示例的开销可能太大,但对于更长的示例,您可以使用@example relative/path/to/example
来拉取文件,这应该会得到缩进权限。