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中得到纠正。
答案 0 :(得分:4)
简短示例的开销可能过多,但是对于较长的示例,您可以@example relative/path/to/example
拉入一个文件,这应该会缩进。