Feedback do trabalho final

Relatórios reprodutíveis com R - Curso de Verão IME-USP 2024

Ministrante: Beatriz Milz

Olá!

  • Como estão?

Plano para hoje

  • Conversa sobre o trabalho final

  • Comentários gerais sobre os trabalhos

Conversa sobre o trabalho final

Quais foram as impressões de vocês sobre os trabalhos finais?

  • Mandem no chat :)

Objetivo do trabalho final

  • Aplicar os conceitos aprendidos durante o curso em um relatório reprodutível.

Quantidade de entregas

Objetivo do feedback

  • Oferecer sugestões para que em atividades futuras (no trabalho, universidade, etc) vocês possam melhorar os relatórios gerados.
  • Os monitores oferecem um feedback inicial, e eu complemento e envio.

Vamos aos feedbacks!

Comentários baseados nos trabalhos já revisados!

Estrutura do relatório

  • É interessante ter seções que representem a introdução, desenvolvimento e conclusão.

Estrutura do relatório

  • A introdução pode conter uma breve descrição do que será apresentado no relatório, sendo importante constar um objetivo claro.

  • Se possível, tente escrever algumas perguntas que você pretende responder com a análise.

Estrutura do relatório

  • A conclusão pode resgatar os objetivos e a pergunta a ser respondida, e apontar quais foram as respostas e principais pontos encontrados.

  • É interessante adicionar ideias para análises futuras.

Base de dados

  • Caso seja uma base de dados pública, é interessante apontar informações como:
    • Nome da base de dados
    • Link para a base de dados (URL para que outras pessoas encontrem)
    • Descrição da base de dados
    • Data de atualização (se existir)
    • Data de acesso à base de dados
    • Autores da base de dados (ex. qual órgão público? foi obtido no kaggle? etc).

Idioma do relatório

lang: pt

Centralizar imagens

  • Utilize o argumento fig-align: center para centralizar as imagens geradas em chunks.

  • Em caso de imagens geradas via código markdown, utilize o argumento fig-align="center".

![](img-feedback/escala-naruto.jpg){fig-align="center"}
  • Caso, mesmo assim, a imagem não esteja centralizada, utilize a “força bruta” e centralize com HTML:
<center>
  ....
</center>

Não apresentar tabelas como output do R

Utilize funções de criação de tabelas (como knitr::kable(), flextable::flextable(), DT::datatable(), reactable::reactable(), entre outros) para melhorar a aparência das tabelas.

Renomear colunas das tabelas

  • Algumas funções de tabela apresentam um argumento para alterar o nome das colunas.

  • Outra opção é renomear as colunas logo antes de usar a função que gera a tabela (ex. knitr::kable()), usando a função dplyr::rename().

```{r}
dados::pinguins |> 
  dplyr::count(especie) |> 
  dplyr::rename("Espécie" = especie, "Quantidade" = n) |>
  knitr::kable()
```
Espécie Quantidade
Pinguim-de-adélia 152
Pinguim-de-barbicha 68
Pinguim-gentoo 124

Tabelas com muitas linhas

  • Evitar, pode deixar o relatório pesado.

  • Caso você queira muito disponibilizar a base completa, poderia deixar embaixo um link para download da mesma.

  • O melhor é manter no corpo do texto apenas coisas que serão úteis e espera-se que as pessoas leiam. Sugestão: apresentar os 10 registros mais importantes (e isso vai depender do gráfico que está sendo gerado).

Citando pacotes (trabalho)

Citando pacotes (sugestão)

Para realizar as análises, foram utilizados pacotes disponíveis no CRAN, tais como: dplyr (Wickham, François, et al. 2023), ggplot2 (Wickham, Chang, et al. 2023), knitr (Xie 2023), reactable (Lin 2023), flextable (Gohel e Skintzos 2023), readxl (Wickham e Bryan 2023) e DT (Xie, Cheng, e Tan 2023).

Citando pacotes (como fazer - parte 1)

format:
  html:
    code-link: true
bibliography: "feedback-packages.bib"

Citando pacotes (como fazer - parte 2)

Para realizar as análises, foram utilizados pacotes disponíveis no CRAN, tais como: `{dplyr}` [@R-dplyr], `{ggplot2}` [@R-ggplot2], `{knitr}` [@R-knitr], `{reactable}` [@R-reactable], `{flextable}` [@R-flextable], `{readxl}` [@R-readxl] e `{DT}` [@R-DT].


```{r}
knitr::write_bib(c(
  "dplyr",
  "ggplot2",
  "knitr",
  "reactable",
  "flextable",
  "readxl",
  "DT"
),
file =  "feedback-packages.bib")
```

Mais importante: Documentação do Quarto

Fechamento do curso

Próximos passos

  • Aula extra sobre Git e GitHub (opcional): 06/03. O acesso é igual às aulas comuns (através da plataforma).

  • Irei enviar para a secretaria do IME as notas para receberem o certificado. Em breve vocês devem receber um retorno.

  • Amanhã irei atualizar o repositório do curso com os materiais completos.

Recebimento de certificado

Para receber o certificado, é necessário:

  • Presença nas aulas (regra USP: mínimo 75% de presença, ou seja, ter participado de pelo menos 4 das 5 aulas)

  • Entrega do trabalho final (quem entregou recebeu a pontuação máxima)

  • Formulário pós-curso - 1 ponto extra! (precisa se identificar no formulário para contar)

Feedback do curso

Agradeço a participação de todas e todos!

Referências citadas nos slides

Slides por Beatriz Milz, feito com Quarto. Código disponível no GitHub.

Gohel, David, e Panagiotis Skintzos. 2023. flextable: Functions for Tabular Reporting. https://ardata-fr.github.io/flextable-book/.
Lin, Greg. 2023. reactable: Interactive Data Tables for R. https://glin.github.io/reactable/.
Wickham, Hadley, e Jennifer Bryan. 2023. readxl: Read Excel Files. https://readxl.tidyverse.org.
Wickham, Hadley, Winston Chang, Lionel Henry, Thomas Lin Pedersen, Kohske Takahashi, Claus Wilke, Kara Woo, Hiroaki Yutani, e Dewey Dunnington. 2023. ggplot2: Create Elegant Data Visualisations Using the Grammar of Graphics. https://ggplot2.tidyverse.org.
Wickham, Hadley, Romain François, Lionel Henry, Kirill Müller, e Davis Vaughan. 2023. dplyr: A Grammar of Data Manipulation. https://dplyr.tidyverse.org.
Xie, Yihui. 2023. knitr: A General-Purpose Package for Dynamic Report Generation in R. https://yihui.org/knitr/.
Xie, Yihui, Joe Cheng, e Xianying Tan. 2023. DT: A Wrapper of the JavaScript Library DataTables. https://github.com/rstudio/DT.