Sweave

Sweave se inscribe en lo que se ha venido a denominar Literate Statistics. El objetivo es tener en un único fichero de sintaxis el texto de LaTeX y el código de R entremezclados. Cuando se procesa el código, el output mezcla automáticamente el texto de LaTeX con las tablas y otros objetos de R, lo que facilita enormemente algunas tareas como la generación periódica de informes o de textos cuando se cambian, aunque sea mínimamente, los datos de origen.

Requerimientos

• Una distribución LaTeX instalada y funcionando (teTex en GNU/Linux o MiKTeX en M$).
• Tener instalado y funcionando el sistema R.
• Un editor de sintaxis, preferentemente Emacs aunque bajo M$ se puede usar también WinEdt.

Sintaxis básica

Los archivos de sintaxis de Sweave deben guardarse con la extensión .Rnw.

La mayor parte del fichero tendrá la apariencia de un archivo de LaTeX (incluidos los encabezados), aunque con la particularidad de contener chunks, que pueden entenderse como partes diferenciadas de la sintaxis correspondientes a distintos tipos de código.

Los chunks de texto, que serán procesados por LaTeX, deben empezar por el signo @:

@
Aquí empieza el texto

En cambio, los chunks del código que debe ser evaluado por R deben empezar por la cadena <<argumentos>>=:

<<Argumento1=ValorDelArgumento1, Argumento2=ValorDelArgumento2, ...>>=
Código de R

Los argumentos pueden ser, entre otros:

• echo=TRUE o echo=FALSE para mostrar u ocultar el código de R (input) en el documento final
• hide=FALSE o hide=TRUE para mostrar u ocultar el resultado de R (output) en el documento final
• leo, completas tu esta parte de los argumentos? Digo lo de las figuras, etc.

Aunque en la mayoría de ocasiones el código de R debe situarse en chunks, si se trata de una única expresión puede ir dentro de un chunk de texto con la siguiente sintaxis:

@
Se incluyeron \Sexpr{length(seq(1,115))} sujetos.

Algunos ejemplos

• Ejemplo 1:

\documentclass[12pt]{report}
\begin{document}
Se incluyeron \Sexpr{length(x<-c(rep(c(1,2),225),rep(1,114)))} sujetos, con una proporcion de hombres del  
\Sexpr{100*round(prop.table(table(x))[1],2)} \%.
\end{document}

• Ejemplo 2:

\documentclass[12pt]{report}

\title{Document de prova}
\author{acrida}
\date{\today}

\begin{document}

\maketitle

<<example data 1,echo=FALSE>>=
x <- cbind(c(2,7),c(3,4))
@ 

Aquesta es la taula:

<<example output for data 1,results=tex,echo=FALSE>>=
library(xtable)
xtable(x)
@ 


\end{document}

• Ejemplo 3:

Leo, pones alguno de los ejemplo con figuras, etc, que tenias tu?

Procesamiento

El procesamiento de un archivo de Sweave se compone básicamente de dos pasos:

• La función Sweave() de R, que evaluará los chunks con código de R y convertirá el archivo .Rnw a un archivo .tex convencional.

• Comipilar el documento .tex para obtener, como es habitual en LaTeX, archivos .dvi, .ps o .pdf.

Procesamiento convencional con Emacs bajo GNU/Linux

Antes de poder procesar documentos de Sweave hay que realizar el siguiente procedimiento, que deberá llevarse a cabo sólo una vez en cada ordenador y que permitirá ejecutar la función Sweave() de R sin necesidad de ejecutar manualmente el programa:

• Descargar este shell script, copiarlo a la ubicación /usr/local/bin/ y desde una ventana de terminal ejecutar:

sudo chmod +x /usr/local/bin/Sweave.sh

Una vez hecho esto, ya estamos en disposición de compilar documentos Sweave. Para ello, debemos descargar este archivo Makefile y ediarlo para sustituir la expresión:

nombrearchivo

presente en las dos primeras líneas, por el nombre de nuestro fichero Sweave sin la extensión .Rnw.

El fichero Makefile debe situarse en el mismo directorio donde tengamos el archivo .Rnw.

Así, para cada proyecto Sweave que tengamos, deberemos tener un directorio independiente con dos archivos: fichero.Rnw y un Makefile que en las dos primeras líneas contenga el nombre del archivo .Rnw (sin la extensión).

Una vez hecho esto, debemos editar el archivo .Rnw en Emacs, grabarlo y pulsar:

M-x
compile {Ret}
make -k {Ret}

Este procedimiento va a generar dos archivos con el documento final, un .pdf y otro .ps. Este último formato presenta la ventaja de ser visualizable con Gnome Ghost Viewer, que actualiza directamente la vista de los archivos .ps cuando estos cambian (es decir cada vez que se produce una nueva compilación) sin necesidad de tener que cerrar y volver a abrir el programa. Para que esto sucesa, hay que marcar la opción Mira un fitxer en las preferncias del programa.

Procesamiento alternativo con Emacs bajo GNU/Linux

El sistema descrito con anterioridad presenta la gran ventaja de ejecutar todo el proceso con una única orden, lo que facilita la realización de compilaciones sucesivas para ir comprobando cómo está quedando nuestro documento, y detectar de forma temprana los errores en el código de R.

Sin embargo, presenta también algún invonvenient, como por ejemplo el hecho que no se genera de forma visible un documento .tex que en ocasiones sería necesario recompilar para obtener, por ejemplo, una bibliografía con el sistema BibTeX.

A completar mediante el link:

Otro enfoque, este toma los nombres del buffer

Procesamiento con Emacs o WinEdt bajo M$

En sistemas M$ no se pueden automatizar los dos pasos necesarios para la genración de documentos Sweave, por lo que deberán realizarse por separado:

• Ejecutar en R (directamente en el programa o mandando la orden desde un editor):

Sweave(nombredelarchivo.Rnw)

• Compilar con LaTeX el archivo .tex resultante de la operación anterior.

Enlaces de interés

Rnews: Sweave Parte I

Rnews: Sweave parte II: Vignettes