Justificativa:

• Produzir relatórios de análise de dados é competência central para o Estatístico(a) e uma das principais atribuições.
• Quando a produção de relatórios é periódica, macanísmos de automação poupam tempo valioso.

Objetivos

• Definir a terminologia.
• Mostrar os recursos disponíveis usando o LaTeX e R.

Literate Programming (LP)

• Um programa tradicional tem código e contém com comentários auxilires.
• Em LP, a “prosa” contém código.
• LP is the art of preparing programs for human readers. (https://www.cs.tufts.edu/~nr/noweb/).
• Ferramentas separam o código da prosa para gerar os fontes e a documentação.
• É mais que uma forma de geração automática de documentação (Ben Bolker).
• Mas o código não é avaliado então não gera resultados.

Reproducible Research (RR)

• Também mistura prosa e código.
• Produzir documentos (artigo, relatório, etc) e não software.
• O documento é autocontido e “executável”.
• Então o código é sempre reavaliado.
• Alimenta o documento com gráficos, tabelas e valores.
• Sem mais copia-cola, erros de transferência e procedimentos ocultos.
• Mais procedimentos de CLI e menos de GUI.
• http://www.leg.ufpr.br/~walmes/papercompanions/gammacount2014/papercomp.html.
• Mais difícil para quem escreve'' mais fácil para quemlê’’.

Vamos desenhar isso!

Descrição

• Sweave é uma funcionalidade da linguagem R que permite entrelaçar fragmentos de código R em documentos LaTeX. O código R é interpretado o resultado que ele produz é inserido no documento LaTeX facilitando principalmente a inclusão de figuras, tabelas e valores numéricos no meio do texto. Não é apenas essa a conveniência, mas isso torna o documento dinâmico.
• LEISCH F. (2002) Sweave: Dynamic Generation of Statistical Reports Using Literate Data Analysis. In: HÄRDLE W., RÖNZ B. (eds) Compstat. Physica, Heidelberg.
• Sweave User Manual - Friedrich Leisch.
• Introduction to Sweave - Michael Lundholm.
• An Sweave Demo.
• Pweave: funcionalidade análoga para o Python.

Processo

O processo é baseado em duas etapas.

• weave = tecer:
  • Definição: to make cloth by crossing long threads over and under each other on a machine called a loom.
  • Resultado: interpretar o código R e incluir/substituir o/pelo resultado correspondente.
• tangle = ??:
  • Definição: the untidy shape that things make when they are twisted round each other or round something else.
  • Resultado: extração dos fragmentos de código R para um script R.

No R, os comandos a seguir executam as etapas mencionadas.

1. Sweave("arquivo.Rnw"): interpreta os fragmentos de código R e cria o .tex.
2. tools::texi2pdf("arquivo.tex"): compila o .tex para .pdf.
3. Stangle("arquivo.Rnw"): extraí o conteúdo dos fragmentos de código R e cria o .R.

Prós e contras

• (+) Automação na inserção de elementos no texto.
• (+) Torna o documento dinâmico.
• (+) Combina a flexibilidade e superioridade tipográfica do LaTeX com o arsenal para análise de dados e recursos computacionais da linguagem R.
• (-) Laborioso para controlar dimensão das figuras.
• (-) Sem armazenamento permamente de resultados da execução.

Sobre

• Surgiu no final de 2011
• Feito por Yihui Xie
• Mais flexível, fácil e preparado para a Web.
• Knitr o é resultado da equação abaixo

knitr =
    Sweave +
    cacheSweave +
    pgfSweave +
    weaver +
    animation::saveLatex +
    R2HTML::RweaveHTML +
    highlight::HighlightWeaveLatex +
    0.2 * brew +
    0.1 * SweaveListingUtils +
    more

Vantagens

• knit + R (to knit = tricotar).
• Uma re-implementação/ampliação mais moderna do Sweave.
• Permite entrelaçar textos do LaTeX, HTML e Markdown com fragmentos de código R.
• Também permite misturar texto com códigos de outras linguagens: Python, awk, C++, shell.
• Adiciona muitos outros recursos como:
  • Cache (armazenamento permanente de artefatos da execução).
  • Decoração e formatação automática de códigos.
  • Geração de gráficos mais direta.
  • Fácil inclusão de animações nos documentos.

Mais opções para controle

• O knitr permite um controle mais fino de execução e exibição.
• Opções do Knitr
• As mais utilizadas são:
  • Exibir input: echo = {TRUE, FALSE}.
  • Como exibir output: results = {"markup", "hide", "asis", "hold"}.
  • Avalir o código: eval = {TRUE, FALSE}.
  • Armazenar resultados: cache = {TRUE, FALSE}.
  • Que linguagem usar: engine = {"sh", "python", "awk", "tikz", etc}.
  • Como exibir figuras: fig.show = {"asis", "hold", "hide", "animate"}.
  • Texto da legenda: fig.cap = "Minha legenda.".
  • Dimensões da imagem: fig.width = 600, fig.height = 400.

Exportar tabelas

Com o knitr pode-se produzir documentos finais em PDF usando LaTeX ou Markdown (R markdown) e documento HTML usando HTML (Rhtml) ou Markdown.

Para exportar tabelas para renderização em markdown usa-se a função knitr::kable().

library(knitr)
kable(mtcars[1:2, 1:3])

|              | mpg| cyl| disp|
|:-------------|---:|---:|----:|
|Mazda RX4     |  21|   6|  160|
|Mazda RX4 Wag |  21|   6|  160|

Para exportar para LaTeX pode-se usar a xtable::xtable(). Com a opção type = "html" exporta-se para HTML.

library(xtable)
xtable(mtcars[1:2, 1:3])

% latex table generated in R 3.4.4 by xtable 1.8-2 package
% Thu Mar 22 20:13:05 2018
\begin{table}[ht]
\centering
\begin{tabular}{rrrr}
  \hline
 & mpg & cyl & disp \\ 
  \hline
Mazda RX4 & 21.00 & 6.00 & 160.00 \\ 
  Mazda RX4 Wag & 21.00 & 6.00 & 160.00 \\ 
   \hline
\end{tabular}
\end{table}

library(xtable)
print(xtable(mtcars[1:2, 1:3]), type = "html")

<!-- html table generated in R 3.4.4 by xtable 1.8-2 package -->
<!-- Thu Mar 22 20:13:05 2018 -->
<table border=1>
<tr> <th>  </th> <th> mpg </th> <th> cyl </th> <th> disp </th>  </tr>
  <tr> <td align="right"> Mazda RX4 </td> <td align="right"> 21.00 </td> <td align="right"> 6.00 </td> <td align="right"> 160.00 </td> </tr>
  <tr> <td align="right"> Mazda RX4 Wag </td> <td align="right"> 21.00 </td> <td align="right"> 6.00 </td> <td align="right"> 160.00 </td> </tr>
   </table>

Outros pacotes para tabela

A task view de Reproducible Research concentra os principais recursos disponíveis para geração automática de documentos. O pacote tables, Hmisc e reporttools são alguns dos pacotes com funcionalidades para LaTeX.

• reporttools
• tables
• Hmisc

library(tables)

tb <- tabular((Species + 1) ~
                  (n = 1) +
                  Format(digits = 2) *
                  (Sepal.Length + Sepal.Width) *
                  (mean + sd),
              data = iris)
tb

##                                                   
##                 Sepal.Length      Sepal.Width     
##  Species    n   mean         sd   mean        sd  
##  setosa      50 5.01         0.35 3.43        0.38
##  versicolor  50 5.94         0.52 2.77        0.31
##  virginica   50 6.59         0.64 2.97        0.32
##  All        150 5.84         0.83 3.06        0.44

Hmisc::latex(tb)

\begin{tabular}{lccccc}
\hline
 &  & \multicolumn{2}{c}{Sepal.Length} & \multicolumn{2}{c}{Sepal.Width} \\ 
Species  & n & mean & sd & mean & \multicolumn{1}{c}{sd} \\ 
\hline
setosa  & $\phantom{0}50$ & $5.01$ & $0.35$ & $3.43$ & $0.38$ \\
versicolor  & $\phantom{0}50$ & $5.94$ & $0.52$ & $2.77$ & $0.31$ \\
virginica  & $\phantom{0}50$ & $6.59$ & $0.64$ & $2.97$ & $0.32$ \\
All  & $150$ & $5.84$ & $0.83$ & $3.06$ & $0.44$ \\
\hline 
\end{tabular}

Subir o código dessa tabela no https://www.tablesgenerator.com/ para ver como ficou.

• odfWeave: Sweave com documentos do LibreOffice Writer.