¿Es posible incluir una imagen en la documentación generada por roxygen? Tengo una serie de funciones que son esencialmente wrappers para ggplot() que me gustaría documentar mostrando un ejemplo de la salida.Incluyendo una imagen con la documentación de roxygen
De acuerdo con la lista de cambios desde el anuncio de R 2,14:
Rd marcado tiene una nueva etiqueta \ figura de modo que las cifras pueden ser incluidos en páginas de ayuda cuando se convierte a HTML o LaTeX. Hay ejemplos en las páginas de ayuda para par() y puntos().
Desde: http://cran.r-project.org/doc/manuals/R-exts.html#Figures
Para incluir figuras en las páginas de ayuda, utilice el \ cifra de marcado. Hay tres formas.
Las dos formas simples comúnmente utilizadas son \ figure {filename} y \ figure {filename} {alternate text}. Esto incluirá una copia de la figura en HTML o salida LaTeX. En salida de texto, se mostrará el texto alternativo en su lugar. (Cuando se omite el segundo argumento, se usará el nombre del archivo.) Tanto el nombre del archivo como el texto alternativo se analizarán textualmente, y no deberían incluir caracteres especiales que sean significativos en HTML o LaTeX.
El formulario de experto es \ figure {filename} {options: string}. (La palabra 'opciones:' debe escribirse exactamente como se muestra y seguida por al menos un espacio.) En esta forma, la cadena se copia en la etiqueta HTML img como atributos que siguen el atributo src, o en el segundo argumento de la \ Figura macro en LaTeX, que de forma predeterminada se utiliza como opciones para una llamada \ includegraphics. Como es poco probable que una sola cadena sea suficiente para ambos modos de visualización, la forma experta normalmente estaría envuelta en condicionales. Depende del autor asegurarse de que se use HTML/LaTeX legal. Por ejemplo, para incluir un logotipo en formato HTML (usando la forma simple) y LaTeX (utilizando el formulario de expertos), se podría utilizar la siguiente:
\if{html}{\figure{logo.jpg}{Our logo}}
\if{latex}{\figure{logo.jpg}{options: width=0.5in}}
Los archivos que contienen las cifras deben ser almacenados en el hombre directorio/figuras Los archivos con las extensiones .jpg, .pdf, .png y .svg de ese directorio se copiarán en el directorio help/figures en el momento de la instalación. (Las cifras en formato PDF no se mostrarán en la mayoría de los navegadores HTML, pero podrían ser la mejor opción en los manuales de referencia.) Especifique el nombre del archivo relativo a man/figures en la directiva \ figure.
Simplemente use la sintaxis normal Rd. – hadley
Si pudiera encontrarla, no la habría preguntado. La única lista exhaustiva de sintaxis que pude encontrar estaba en Bioconducter ... y no incluía sintaxis para incluir una imagen. –
Y también en "Writing R Extentions". –