2011-08-08 8 views
7

Roxygen ha hecho que mi trabajo sea mucho más fácil y, en la mayoría de los casos, es agradable e intuitivo. Una cosa que nunca he dado cuenta de que es cómo preservar la sangría en las secciones @examples de manera que el resultado de roxygenize("myPackage") contienePreservar la sangría en la sección de ejemplos

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

habría

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

en lugar de

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

Es un pequeño detalle pero hace que todos los ejemplos más simples sean innecesariamente difíciles de leer, así que agradecería que alguien me pueda ayudar.

Editar: Este error se corrigió en las versiones posteriores de roxygen.

+0

¿Estás usando 'roxygen' o' roxygen2'? Estoy bastante seguro de que esto no sucede en roxygen2, y si lo hace es un error, y debería ser informado. – hadley

+0

Estaba usando el antiguo 'roxygen' pero el problema persistió después de actualizar a' roxygen2'. La solución de gsk3 funciona para ambos, pero supongo que será mejor informar de todos modos. ¿Cómo puedo hacer eso? – Backlin

+0

Envíe un informe de errores reproducible a https://github.com/klutometis/roxygen/issues – hadley

Respuesta

4

Probablemente demasiada sobrecarga para ejemplos cortos, pero para ejemplos más largos podría @example relative/path/to/example para obtener un archivo, que debería tener la sangría correcta.

+0

¡Gracias, funciona como un encanto! La sobrecarga no es tan mala también, ya que solo se aplica a algunos ejemplos ocasionales, especialmente cuando se compara con la carga prohibitivamente grande de corregir manualmente la sangría. – Backlin

Cuestiones relacionadas