MC-EA03
Markdown e códigos executáveis na geração de Relatórios dinâmicos

Professor: Lucas da Silva Menezes (LNCC)

Horarios: De Terça (14/02) a Sexta (17/02) de 11:30h às 13:00h

Objetivo: Relatórios dinâmicos são formas reprodutíveis de descrição de resultados de pesquisa na medida em que as tecnologias que os geram são capazes de compilar código, apresentar seus outputs e interpretar seus respectivos textos ao associar linguagens de marcação para a composição de documentos. Tecnologias recentes, capazes de gerar conversões multiformato, permitem uma maior flexibilidade na construção de um documento através da associação de diferentes interpretadores de texto. Assim, softwares como Pandoc, Rmarkdown e Quarto notebooks se apresentam como ambientes funcionais de desenvolvimento de documentos de pesquisa reprodutíveis. O objetivo do seguinte minicurso é apresentar as tecnologias Pandoc e Quarto notebooks e suas respectivas integrações às linguagens de marcação ConTeXt e Markdown para a criação de relatórios dinâmicos.

Pré-requisitos:
  1. Recomendável
    • Conhecimento prévio na linguagem Python, Julia ou R
  2. Desejável (opcional)
    • Conhecimento prévio com gerenciadores de referências (Zotero, Mendeley, EndNote, etc.)
    • Conhecimento prévio em LaTeX ou ConTeXt

Metodologia: Os temas serão apresentados concomitantemente à produção de um relatório dinâmico. O tema para a produção do relatório será de escolha do aluno e as dúvidas associadas à produção do documento poderão ser compartilhadas em uma plataforma de mensagens (Discord) ou especificamente sanadas por mensagens privadas, caso haja restrições ao compartilhamento do trabalho. A linguagem de programação utilizada é de livre escolha, mas vale lembrar que o compilador Quarto interpreta apenas as linguagens Python, Julia e R para a produção de imagens e tabelas.


Ementa:
  1. Introdução ao Markdown
  2. Introdução ao Pandoc e Quarto notebooks
  3. TeX, LaTeX, XeLaTeX, LuaTeX e ConTeXt: uso dos diferentes compiladores no processamento de texto para relatórios dinâmicos
  4. Metadados YAML para modelos padrão Pandoc
  5. Modelos de documento LaTeX e ConTeXt personalizados para Pandoc e Quarto notebooks
  6. Jupyter kernels e compilação de códígo utilizando Quarto notebooks
  7. Parâmetros de figuras e construção de tabelas
  8. Referências e citações com BibTeX usando Zotero e Better BibTeX
  9. Conversão multiformato

Recursos necessários:
  1. Uma vez que a compilação dos documentos ocorrerá localmente, são necessárias as seguintes instalações:
    • Quarto CLI: https://quarto.org/docs/get-started/
    • Pandoc: https://pandoc.org/installing.html
    • Jupyter: https://jupyter.org/install
    • Julia kernel para Jupyter (opcional): https://github.com/JuliaLang/IJulia.jl
  2. Caso haja conhecimento prévio com Mendeley, EndNote ou outro gerenciador de referências, não será necessária a instalação do Zotero
    • Zotero (opcional): https://www.zotero.org/download/
    • Better BibTeX para Zotero: https://retorque.re/zotero-better-bibtex/installation/
  3. Caso haja conhecimento prévio em LaTeX, não será necessária a instalação do ConTeXt
    • ConTeXt (opcional): https://wiki.contextgarden.net/Installation
    • Instalação recomendada de LaTeX para processamento local (Quarto): https://yihui.org/tinytex/
  4. Por sua vez, outras instalações podem ser executadas para as diferentes plataformas
    • Para usuários do sistema Linux: TeX Live (https://tug.org/texlive/) e TexStudio (https://www.texstudio.org/).
    • Para usuários do sistema Windows: MikTeX (https://miktex.org/) e TexStudio (https://www.texstudio.org/).
    • Para usuários do sistema Mac: MacTeX (https://www.tug.org/) e TexMaker (https://www.xm1math.net/)).