5  RMarkdown

5.1 Criando um arquivo Rmd

Para criar um novo documento R Markdown (.Rmd), clique em File -> New File -> R Markdown.

Criando um arquivo R Markdown.

Uma janela se abrirá com opções de template. Escolha o template que melhor se adapta às suas necessidades ou selecione Create Empty Document para um documento em branco.

Um arquivo Rmd é composto por três partes principais:

  • Cabeçalho (YAML): Contém metadados do documento, como título, autor e formato de saída.
---
title: "Meu Primeiro Documento R Markdown"
author: "Seu Nome"
date: "2023-10-27"
output: html_document
---

O cabeçalho deve ser delimitado por --- (traço triplo) e utiliza a síntaxe YAML (pt.wikipedia.org/wiki/YAML).

  • Texto (narrativa): Conteúdo textual do documento, escrito em Markdown. Inicia logo após o cabeçalho e segue a síntaxe demonstrada na seção @ref(rmdsintaxe).

  • Código (chunks): Blocos de código R, delimitados por {r} e (aspas triplas).

Para gerar o documento final (HTML, PDF, etc.), clique no botão “Knit” ou use o atalho Ctrl + Shift + K.

5.2 Síntaxe da linguagem R Markdown

A síntaxe da linguagem RMarkdown é bastante simples, mas poderosa. Neste capítulo, serão apresentados alguns dos principais elementos.

  • Parágrafos: Separe parágrafos com uma linha em branco.

  • Texto:

    • Para deixar um texto em itálico, este deve ser escrito entre * (asterisco simples): *itálico* -> itálico. Já para deixar o texto em negrito, este deve ser escrito entre ** (asterisco duplo): **negrito** -> negrito. E para itálico e negrito? adivinhem, *** (asterisco triplo): ***itálico e negrito*** -> itálico e negrito.

    • Sobrescrito deve ficar entre ^ (circunflexo): m^3^/s = m3/s. Já o subscrito é escrito entre ~ (til): H~2~O = H2O.

  • Listas: Crie listas com * ou números.

    • Uma lista marcada deve ter cada item precedido por um * (asterisco):

* item 1

* item 2

Retorna:

  • item 1

  • item 2

    • Uma lista numerada dever ter cada item precedido por um número:

1. item 1

1. item 2

1. item 3

Retorna:

  1. item 1
  2. item 2
  3. item 3
  • Títulos: Use #, ##, ### para títulos de diferentes níveis.
# Título nível 1

## Título nível 2

### Título nível 3

  • Links: [texto do link](URL). Por exemplo: [Site da UFSC](https://ufsc.br) -> Site da UFSC

  • Imagens: ![texto alternativo](caminho/da/imagem.png)

O RStudio oferece uma folha de dicas com a sintaxe do R Markdown. Consulte para mais opções: R Markdown Cheat Sheet

Muito mais informações podem ser encontradas neste livro bastante completo: R Markdown: The Definitive Guide

5.3 Formatos de saída

Os principais formatos de saída para documentos 1 são:

  • html_document - saída em formato HTML
  • pdf_document - saída em formato PDF
  • word_document - saída em formato Word (.doc)
  • odt_document - saída em formato OpenDocument (.odt) para OpenOffice e LibreOffice
  • rtf_document - saída em formato Rich Text Format (.rtf)

O formato de saída é definido no cabeçalho YAML. Por exemplo, para gerar um PDF:

---
output: pdf_document
---

  1. não irei tratar de apresentações neste livro↩︎