example - Documentando ecuaciones con deqn y roxygen.

r roxygen2 example

Question

Estoy usando /deqn{}{} con roxygen2 para documentar las ecuaciones de una función en un paquete. LaTeX (el primer argumento a deqn ) se procesa bien porque el espacio en blanco se ignora en las ecuaciones de LaTeX, pero tengo un problema con la representación ASCII (el segundo argumento a deqn ).

El problema es que mi formato se destruye (parece que roxygen coloca todo el comando deqn en una "línea única" y luego ajusta esa línea en ~ 60 columnas aproximadamente). ¿Hay alguna forma de forzar a roxygen2 a conservar el formato de espacio en blanco en mis comandos / comentarios de roxygen en el archivo .R?

Tengo el siguiente código en un archivo, example.R :

#''Example
#''
#''deqn ASCII example
#''
#''/deqn{ /sigma = /sqrt{ /frac{Z}{n} /sum
#''  /left[ /textstyle/frac{1}{2}/displaystyle
#''    /left( /log /frac{H_i}{L_i} /right)^2  - (2/log 2-1)
#''    /left( /log /frac{C_i}{O_i} /right)^2 /right] }
#''}{sqrt(N/n * runSum(0.5 * log(OHLC[,2]/OHLC[,3])^2 -
#''           (2*log(2)-1) * log(OHLC[,4]/OHLC[,1])^2, n))}
#''
#''@param x An example parameter
#''@return A example result
#''@author Joshua Ulrich
#''@keywords ts
#''@export
"example" <-
function(x) {
}

Y utilizo el siguiente código R para generar el archivo example.Rd :

library(roxygen2)
setwd("dir/containing/example.R/")
dir.create("man",FALSE)
roclet <- rd_roclet()
roc_proc(roclet, "example.R", ".")
roc_out(roclet, "example.R", ".")

Puede generar la representación de texto del archivo example.Rd usando este comando en la línea de comandos:

R CMD Rd2txt dir/containing/example.R/man/example.Rd

La sección Detalles de la salida del comando anterior se ve así:

sqrt(N/n *
  runSum(0.5 * log(OHLC[,2]/OHLC[,3])^2 - (2*log(2)-1) *
  log(OHLC[,4]/OHLC[,1])^2, n))

mientras que me gustaría que se vea como:

sqrt(N/n * runSum(0.5 * log(OHLC[,2]/OHLC[,3])^2 -
         (2*log(2)-1) * log(OHLC[,4]/OHLC[,1])^2, n))

Answer 1

Según Hadley Wickham , el ajuste de línea se eliminará en futuras versiones de roxygen. Por lo tanto, la solución para roxygen2 es generar el archivo (o paquete) y luego actualizar manualmente la ecuación de texto en el (los) archivo (s) .Rd afectado (s).