Cómo hacer una referencia cruzada de una ecuación en un archivo de ayuda de R / roxygen2

Question

Estoy en el proceso de documentar algunas de mis funciones para un paquete R que estoy creando.

Estoy usando el marcado roxygen, aunque eso es en gran parte irrelevante para mi pregunta.

He incluido ecuaciones en mi documentación usando \deqn{...}. Mi pregunta es: ¿Hay alguna forma de hacer una referencia cruzada de esta ecuación más adelante?

Por ejemplo, en mi archivo Rd:

\deqn{\label{test}
 y = mx + b
}

¿Puedo hacer algo como:

Refiriéndose a la ecuación \ ref {prueba}, ...

He probado \eqref{test}, \ref{test} (que obtienen "macro desconocida" y no se vinculan) y también \link{test} (que se queja de que no puede encontrar la función test porque en realidad es solo para vincular a otras funciones).

De lo contrario, me temo que tendré que hacer algo hacky y agregar el -- (1) y Refer to equation (1) manualmente dentro del \deqn, etc. en el archivo Rd ...

Actualización

La respuesta general parece ser "no". (awww ...)

Sin embargo, puedo escribir una viñeta y usar paquetes / látex "normales" allí. En cualquier caso, acabo de notar que las ecuaciones matriciales que pasé años poniendo en mi archivo roxygen / Rd se ven horribles en la versión ?myFunction de la ayuda (aparecen como una fuente de látex casi literal). Lo cual es una pena, porque se ven hermosos en la versión en pdf de la ayuda.

@Iterator ha señalado la existencia de texto condicional , así que haré matemáticas ASCII en los archivos .Rd, pero matemáticas de Latex en el manual / viñeta en pdf.

Answer 1

Estoy compilando mis comentarios anteriores en una respuesta, en beneficio de otros.

En primer lugar, no sé si .Rd admite el etiquetado de ecuaciones o no. Sin embargo, el formato .Rd es un subconjunto tan estricto de LaTeX, y produce una salida de texto muy primitiva, que introducir ecuaciones extensas en su formato podría ser una tarea dolorosa sin mucho beneficio para el usuario.

La alternativa es utilizar viñetas de paquetes , o incluso documentación alojada externamente (como lo hace Hadley Wickham, para algunos de sus paquetes). Esto le permitirá utilizar archivos PDF u otra documentación, al contenido de su corazón. De esta manera, puede incluir capturas de pantalla, gráficos, todas las extensiones de LaTeX más divertidas que solo usted tiene y, lo más importante, las extensiones AMS que todos conocemos y amamos.

No obstante, se puede especificar una representación diferente de una sección determinada de la documentación (en .Rd) según la interfaz, como texto para la consola, caracteres agradables para HTML, etc., y texto condicional admite ese tipo de variación de formato.

Es una buena pregunta. No sé la respuesta con respecto a la viabilidad, pero tenía preguntas similares sobre cómo documentar funciones y ecuaciones juntas, y esta investigación sobre lo que es factible con los archivos .Rd me ha convencido de usar viñetas PDF en lugar de archivos .Rd.