Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Preserving indentation in examples section

Tags:

r

roxygen

Roxygen have made my work a lot easier and is in most cases nice and intuitive. One thing that I have never figured out though is how to preserve indentation in @examples sections so that the result of roxygenize("myPackage") containing

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

would be

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

instead of

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

It is a small detail but it makes all but the simplest examples unnecessarily hard to read so I'd appreciate it if someone can help me.

Edit: This bug was corrected in later versions of roxygen.

like image 819
Backlin Avatar asked Aug 08 '11 13:08

Backlin


1 Answers

Probably too much overhead for short examples, but for longer examples you could @example relative/path/to/example to pull in a file, which should get the indenting right.

like image 74
Ari B. Friedman Avatar answered Oct 04 '22 03:10

Ari B. Friedman