Sugestões para relatórios de meus alunos

Jan 13, 2023 3 min read Blog Post

Guia de Boas Práticas para Escrita de Relatórios com R Markdown

Introdução

Aqui você encontrará orientações essenciais para criar relatórios bem formatados e claros utilizando R Markdown quando. A seguir, apresentamos uma lista de pontos que devem ser observados ao preparar seu relatório para uma disciplina.

Estrutura do Documento

  1. Nome e Título
    • Nome: Coloque seu nome completo no início do documento.
    • Título: Escolha um título claro e descritivo que reflita o conteúdo do seu relatório.
   ---
   title: "Título do Relatório"
   author: "Seu Nome Completo"
   date: "`r format(Sys.Date(), '%d/%m/%Y')`"
   output: html_document
   ---
  1. Cabeçalhos e Subcabeçalhos
    • Utilize cabeçalhos (#, ##, ###, etc.) para organizar o conteúdo de forma hierárquica e facilitar a leitura.

Formatação de Código

  1. Código no Texto

    • Certifique-se de que todo o código cabe na largura da página sem necessidade de rolagem horizontal.

  2. Não Imprimir Warnings

    • Suprima mensagens de aviso (warnings) que não são relevantes para a interpretação dos resultados.
   ```{r, warning=FALSE}
   # Código sem warnings
   summary(mtcars)
    ```
  1. Evitar Longas Tabelas
    • Não imprima tabelas extensas diretamente no relatório. Utilize funções como head() ou kableExtra para mostrar apenas partes relevantes ou resumos das tabelas.
   ```{r}
   library(knitr)
   library(kableExtra)
   # Exemplo de tabela compacta
   kable(head(mtcars), format = "html") %>%
     kable_styling(bootstrap_options = c("striped", "hover"))
    ```

Boas Práticas de Formatação

  1. Comentário de Código
    • Comente seu código de forma clara para explicar a finalidade de cada bloco. Isso ajuda na compreensão e manutenção do código.
   ```{r, echo=TRUE}
   # Calcula o resumo estatístico do dataset mtcars
   summary(mtcars)
    ```
  1. Gráficos e Visualizações
    • Ao inserir gráficos, certifique-se de que eles são legíveis e relevantes. Ajuste os tamanhos conforme necessário.
   ```{r, fig.width=6, fig.height=4}
   # Gráfico de dispersão
   plot(mtcars$wt, mtcars$mpg, main="Peso vs. MPG",
        xlab="Peso do Carro", ylab="MPG")
    ```
  1. Referências e Bibliografia
    • Inclua todas as referências de forma adequada utilizando o formato de citação escolhido. Você pode usar o rmarkdown para gerenciar a bibliografia.
   ---
   bibliography: references.bib
   ---

   # Citando uma referência
   De acordo com @autor2020, ...

Outros

  1. Revisão

    • Revise seu relatório antes de enviar. Verifique ortografia, gramática e se todas as seções estão bem organizadas e coerentes.

  2. Versão PDF

    • Se for necessário enviar o relatório em formato PDF, utilize a opção de renderização apropriada no R Markdown.

  3. Índice

    • Inclua um índice se o relatório for extenso. Isso ajuda na navegação pelo documento.
    output:
      html_document:
        toc: true
        toc_depth: 3
  1. Estilo de Texto
    • Use itálico, negrito e listas para destacar pontos importantes.
    - **Importante:** Este é um ponto crucial.
    - *Nota:* Este é um detalhe adicional.
  1. Incorporar Imagens e Links
    • Adicione imagens e links para enriquecer o conteúdo do relatório.
    ![Título da Imagem](caminho/para/imagem.png)
    
    [Link para um recurso útil](http://www.exemplo.com)
  1. Interatividade
    • Para documentos HTML, considere incluir widgets interativos com pacotes como shiny ou plotly.
    ```{r, echo=FALSE}
    library(plotly)
    plot_ly(data = mtcars, x = ~wt, y = ~mpg, type = 'scatter', mode = 'markers')
     ```
  1. Cache de Resultados
    • Utilize o cache para evitar a reexecução de códigos demorados sempre que o documento for renderizado.
    ```{r, cache=TRUE}
    # Código que demora para ser executado
    long_computation <- lm(mpg ~ wt, data = mtcars)
    summary(long_computation)
     ```

Seguindo essas diretrizes, você conseguirá criar relatórios bem organizados e com uma apresentação profissional, facilitando a leitura e a compreensão dos resultados apresentados.

Portuguese Alunos