Markdown é uma ferramenta de conversão de texto em HTML para escritores da web. O R Markdown permite que você escreva texto simples de fácil leitura e escrita e insira fórmulas, imagens e script do R com comentário e comandos. John Gruber

1 Criar um novo arquivo

Clique em File + New File + R Markdown (Figura 1).

Figura 1: Como abrir um arquivo novo de R Markdown

2 Nomear o arquivo

Insira um titulo e o seu nome como autor, deixe clicado a forma de salvar como HTML, pois neste formato você pode posteriormente salvar em PDF ou Word. Depois clique em OK (Figura 2). Caso não queira que apareça o título e nome do autor é so deixar em branco ou apagar posteriormente, isso serve também para data.

Figura 2: Atribuindo nome e autoria ao novo arquivo R Markdown

3 Aparência do R Markdown

A aparência inicial do novo arquivo R Markdown, traz um cabeçalho e exemplo de como postar tabela e gráfico (Figura 3).

As informações após o cabeçalho podem ser apagadas. Deixe apenas o cabeçalho.

Figura 3: Aparência inicial do novo arquivo R Markdown

4 Salvar o novo arquivo

Para salvar seu novo arquivo clique no disquete (Figura 4).

Figura 4: Salvar o novo arquivo R Markdown

5 Escolher a pasta e nomear o arquivo

Escolha uma pasta e dê um nome ao novo arquivo e clique em Save. (Figura 5)

Figura 5: Salvando o novo arquivo R Markdown

6 Visualizar o novo arquivo em HTML

Para visualizar seu arquivo R Markdown e conferir como esta ficando seu relatório clique em Knit ou dê um Ctrl+Shift+k. (Figura 6).

Figura 6: Como visualizar o arquivo R Markdown

7 Aparência do Novo arquivo em HTML

Aparência do seu arquivo Markdown em HTML que posteriormente pode ser carregado em um site ou salvo em word e/ ou PDF

Figura 7: Aparência do arquivo R Markdown

8 Inserir sumário

Você pode adicionar um índice analítico toc.
1. toc_depth: O sumário aparece logo após o cabeçalho.
2. toc_float: para o sumário aparecer no canto superior esquerdo.
Você pode especificar uma lista de opções para o toc_floatparâmetro que controla seu comportamento. Essas opções incluem:

collapsed(o padrão é TRUE) controla se o sumário, aparece apenas com os cabeçalhos de nível superior. O sumário é expandido automaticamente em linha quando necessário.
smooth_scroll(o padrão é TRUE) controla se as rolagens da página são animadas quando os itens de sumário são navegados por meio de cliques do mouse.

| P.S: Respeite os espaços a esquerda dos comandos. Isso é muito importante para que o R Markdown rode perfeitamente.

Opção 1 - O sumário aparece logo após o cabeçalho
---
title: "Criar um arquivo R Markdown"
output:
  html_document:
    toc: true
    toc_depth: 2
---
Opção 2 - O sumário aparece no canto superior esquerdo 
---
title: "Criar um arquivo R Markdown"
output:
  html_document:
    toc: true # ou yes
    toc_float: true # true ou yes
---

Opção 3 - O sumário expande automaticamente em linhas quando necessário
---
title: "Criar um arquivo R Markdown"
output:
  html_document:
    toc: true # ou yes
      collapsed: false # ou no
      smooth_scroll: false # ou no
---
        
Opção 4 - Rolagens da página são animadas com o clique do mouse
---
title: "Criar um arquivo R Markdown"
output:
  html_document:
    toc: true # ou yes
      collapsed: false # ou no
      smooth_scroll: false # ou no
---

9 Numeração de seção

. number_sections: Adicionar numeração das seções do cabeçalho igual norma ABNT.

---
title: "Criar um arquivo R Markdown"
output:
  html_document:
    toc: true # ou yes
    number_sections: true # ou yes
---

10 Aparência e estilo

Existem várias opções que controlam a aparência dos documentos HTML:

1. theme: especifica o tema Bootstrap a ser usado para a página (os temas são retirados da biblioteca de temas Bootswatch ). Os temas válidos são: defaul, bootstrap,cerulean, cosmo, darkly, flatly, journal, lumen, paper, readable, sandstone, simplex, spacelab, united, yeti. Coloque nullquando não quiser nenhum tema (neste caso, você pode usar o cssparâmetro para adicionar seus próprios estilos).
b.highlight: especifica o estilo de realce da sintaxe. Os estilos válidos são: default, tango, pygments, kate, monochrome, espresso, zenburn, haddock, breezedark, e textmate. Coloque nullpara evitar o realce da sintaxe.
```
 P.S: Deixe os espaço conforme a imagem, para que o R Markdown possa rodar perfeitamente. Você pode ir testando os estilos até encontrar o que mais se adequar ao seu estilo.
```

Exemplo de Bootstrap e sintaxe usado neste documento de RMarkdown. 
---
title: "Criar um arquivo R Markdown"
output:
  html_document:
      highlight: zenburn
      theme: paper
      number_sections: yes # ou true
      toc: yes
      toc_float:
         collapsed: yes
         smooth_scroll: yes
---

11 Deixar a data automática

Para que o R Markdown atualize sua data automaticamente insira no título date o comando descrito no exemplo abaixo:

---
title: "Criar um arquivo R Markdown"
date: "`r format(Sys.time(), '%d %B, %Y')`" 
output:
  html_document:
      highlight: zenburn
      theme: paper
      number_sections: yes # ou true
      toc: yes
      toc_float:
         collapsed: yes
         smooth_scroll: yes
---

12 Inserir um logo ou imagem antes do Título

Se caso quiser colocar o logo da empresa ou uma imagem antes do título, como a deste documento pode usar o seguinte comando:

Logo depois da palavra title insira <center> ![](endereço da Imagem){ width=70% sytle="display; left:50%" }, este comando deixa a imagem centralizada na página e define o tamanho da imagem. Você pode alterar as porcentagens até se adequar ao tamanho que você deseja.

---
title: |
  <center>
  ![](https://i.imgur.com/1qIPO3t.png){ width=70%   sytle="display; left:50%" }   
  
  Criar um arquivo R Markdown
date: "`r format(Sys.time(), '%d %B, %Y')`"
output: 
    html_document:
      highlight: zenburn
      theme: bootstrap
      number_sections: yes
      toc: yes
      toc_float:
         collapsed: yes
         smooth_scroll: yes
---

13 Elementos básicos do RMarkdown

13.1 Títulos

Os títulos são definidos pela presença e pela quantidade de #. Um único # define o título 1 (o maior na hierarquia), dois # definem o título 2, e assim sucessivamente.
# Título 1
## Título 2
### Título 3

13.2 Formatação

Para que duas frases fiquem em linhas separadas, dê dois espaços entre elas;
Os dois espaços funcionam também para deixar uma linha em branco;
Para deixar uma palavra em negrito, coloque-a entre quatro asteriscos: **negrito**;
Para deixar uma palavra em itálico, coloque-a entre dois asteriscos: *itálico*;
Para deixar caracteres sobrescritos, coloque-os entre acentos circunflexos: ^1^;
Para deixar caracteres subscritos, coloque-os entre til: ~1~;
Para destacar um termo como código, coloque-o entre crases (``)(backticks):código;
Para criar uma citação (quote), escreva o texto após um sinal de maior: > Citação;

Exemplo:

Citação

13.3 Adicionando links

[Nome do Link](Endereço do Link), colocando o mouse encima do nome e clicando, você será direcionado para página do link.

Exemplo:

R Markdown: Gerando relatórios usando o R

13.4 Adicionando imagens

![Legenda](Endereço da Imagem), se você quiser centralizar a imagem no meio da página, basta colocar o comando <center>antes do comando da imagem

Exemplo: <center>![Logo do RMarkdown](https://miro.medium.com/max/600/1*sCJzUnDilAuvGrlllJeXKw.jpeg){ width=40% }, o comando {width=40%}serve para reduzir o tamanho da imagem.

Figura 8: Logo do RMarkdown

Para que as imagens sejam inseridas no RMarkdown, elas necessitam estar armazenadas em algum site, para que possa ser inserido o link da imagem no arquivo do RMarkdown. Um site para inserção de imagens que é facil de postar é o imgr (Link: Imgr). É um site em inglês mais pode ser traduzido usando a função de tradução do Google translate. Neste site você vai fazer um cadastro com seu e-mail ou usando suas redes sociais. Após o cadastro, para inserir uma imagem você deve clicar em nova imagemou Nex post, localizado no canto superior esquerdo da página. Ao clicar em nova imagem, vai abrir uma caixa onde você pode inserir ou arrastar uma imagem. Imediatamente o site faz a postagem da imagem na sua página. Para obter o link da imagem basta clicar com o botão direito do mouse em abrir imagem em uma nova guia. Assim, basta copiar no link que aparece na barra de página. P.S: este link deve finalizar com algumas das extenções de imagem que existe: png, jpeg etc. No exemplo acima a extenção da imagem é em jpeg.

13.5 Criando notas de rodapé (clicáveis)

Ao final da citação insira [^1] Embaixo da citação insira as informações da nota de rodape como exemplificado: [^1]: Esta é uma nota de rodapé. A nota vai aparecer no final da página. Então para vê-lo basta clicar no número.

Exemplo:

Se não houver frutos, valeu a beleza das flores; se não houver flores, valeu a sombra das folhas; se não houver folhas, valeu a intenção da semente ¹:

13.6 Listas não-ordenadas

Usamos asterisco para criar o item, sinal de adição para criar o subitem e traço para criar o sub-subitem. A cada nível devem ser dados 4 espaços antes.
* Item
+ Subitem
- Sub-subitem

Exemplo:

Item 1
- Subitem 1
  - Sub-subitem 1

13.7 Adicionando equações

As equações no RMarkdown são escritas com a linguagem LaTeX.

Para que a equação apareça no meio do texto, devemos escrevê-la entre dois cifrões: $equação$

Para que ela apareça separada do texto e centralizado, deve ser colocada entre quatro cifrões:

$$equação$$

Exemplo:

Fórmula no meio do texto: $Y= \beta_0 + \beta_1 + \beta_2 + \epsilon$. $Y= \beta_0 + \beta_1 + \beta_2 + \epsilon$

Fórmula centralizada:

\[ \sum_ {i = 1} ^ n = \frac{(x-\mu)}{\sigma} \] $$\sum_ {i = 1} ^ n = \frac{(x-\mu)}{\sigma} $$

Para elaborar fórmulas ou equações no RMarkdown é preciso saber os comandos corretos para montar-lás. O site Latex ajuda nesta elaboração. (clique no Link: Latex).

  O site possui todos os símbolos que podem ser usados na elaboração da fórmula ou equação. Ao clicar nos icones o comando aparecerá na caixa de texto, e na parte inferior a fórmula ou equação aparecerá em seu formato final. Este site permite também copiar a fórmula ou equação como imagem.

Figura 9: Site Latex

13.8 Incluindo códigos R

Para adicionar qualquer código em R, devemos iniciar com três crases (```), seguidas por {r} e para encerrar o bloco de código, devemos fechá-lo com outras três crases. Quando vc abrir com as 3 crases e {r}, vai aparecer no lado direito uma engrenagem onde será possível atribuir algumas funções que será descrita abaixo, do lado da engrenagem vai ter uma seta verde para que você possa rodar o comando dentro do chunk e ver se não existe nenhum erro.

no {r} sempre insira um nome ao comando, mais não repita o nome, pois pode gerar erro no Render e não abrir a página HTML no Knit. Exemplo: {r formula}

Após o nome dado ao código é possivel atribuir algumas funções no “chunk”, que devem ser separados por virgula:
eval = FALSE: Exclui o resultado, mas não a fórmula (Caso você queira apenas colocar o comando não o resultado);
echo = FALSE: Exclui a fórmula, mas não o resultado (Caso você queira apenas colocar o resultado sem que o comando apareça);
include = FALSE: Exclui o resultado e a fórmula, mas o chunk ainda é rodado;
message = FALSE: Exclui as mensagens (Este comando é bastante usado quando você precisa baixar a biblioteca de um pacote, mas não quer que apareça as mensagens de carregamento da biblioteca);
warning = FALSE: Exclui os avisos (Este comando é usado também para evitar dos pacotes ou de comando que não são necessarios aparecer no relatório);
paged.print=TRUE: Faz um print do chunk.

Exemplo

  Caso queira inserir um chunk como este aqui, com informações de comando,
Insira na informação entre chaves, logo depois das 3 crases, esse comando:
  {r nome do chunk, eval=FALSE, paged.print=TRUE}

14 Salvar Documentos em RMarkdown

14.1 Visualizar o documento em HTML e salvar em formato HTML

Clique em Open in Browser

Figura 10: Abrir Doc em HTML

Clique em 3 pontos -> Mais Ferramentas -> Salvar página com -> Salvar em extensão HTML. Neste formato você pode compartilhar com outras pessoas por e-mail e outras pessoas pode visualizar seu relatório em HTML, mesmo sem acesso a internet.

Figura 11: Salvar em HTML

Para publicar seu relatório no Rpubs, clique em Publish.

Figura 12: Publicar

Ele abrirá uma janela, então clique em RPubs e posteriormente em Publish.

Figura 13: RPubs

Figura 14: Publicação em RPubs

Faça seu registro no RPubs e após isso, fazer login.

Figura 15: Registro em RPubs

Após o Login coloque informações sobre seu relatorio (Título), (Descrição) e (Slug), criando um nome para extensão do documento. Após isso clique em Continue para postar seu relatório no RPubs.

Figura 16: Informações do seu Relatório

Após publicado é possivel atualizar seu relatório sempre que fizer uma modificação apenas clicando em Publish. Pode-se também compartilhar o link com outras pessoas.

Figura 17: Relatório

15 Exemplo de Relatório

15.1 Estimativa de Densidade Básica utilizando o Pilodyn

Referência: Warrier, K. C. (2014). Use of Pilodyn for Rapid and Reliable Estimation of Wood Basic Density in Clones of Casuarina equisetifolia.

15.1.1 Pacotes Utilizados

library(tidyverse) # pacote com vários pacotes para manipulação de dados
library(readxl) # pacote para leitura de arquivos excel
library(ggpubr) # plotar regressão no gráfico (linear)
library(kableExtra) #tabelas no RMarkdown
library(dplyr) # manipulação de dados

15.1.2 Importar os dados

tb <- read_excel("Dados_xilofogos_pilodyn-densidade.xls",
                 sheet = "Pilodyn")

15.1.3 Ver o Banco de dados

Com a função kbldo pacote KableExtra, você atribui um título a tabela, com a função kable_classic, é possivel criar uma tabela de formato classico, estilo ABNT e atribuir forma da fonte, e tamanho da fonte. E com a função scroll_box, é possivel criar uma barra vertical e horizontal para minimizar o tamanho da tabela no seu RMarkdown, assim você pode inserir sua tabela sem que ela ocupe muito espaço no seu relatório.

tb %>%
  kbl(caption = "Tabela de dados do Pilodyn") %>%
  kable_classic(full_width = F, html_font = "Times", font_size = 20)%>%
  scroll_box(width = "500px", height = "300px")

Tabela de dados do Pilodyn
clones	Pilodyn	densidade
1	4.40	0.84
2	4.98	0.76
3	5.08	0.77
4	4.28	0.83
5	4.63	0.78
6	4.40	0.84
7	6.80	0.59
8	4.33	0.82
9	5.28	0.75
10	5.23	0.72
11	4.40	0.78
12	5.10	0.75
13	4.75	0.79
14	4.63	0.77
15	5.78	0.73
16	4.53	0.78
17	4.65	0.80
18	4.83	0.75
19	5.58	0.72
20	5.73	0.71
21	4.35	0.83
22	4.65	0.76
23	4.63	0.77
24	4.13	0.82
25	5.65	0.69
26	4.53	0.77
27	5.28	0.75
28	4.88	0.78
29	5.30	0.74
30	4.05	0.83
31	4.30	0.79
32	4.73	0.77
33	8.83	0.46
34	5.15	0.74
35	4.30	0.82
36	4.28	0.80
37	4.75	0.75
38	4.93	0.74
39	5.33	0.73
40	5.48	0.72
41	5.70	0.75
42	5.60	0.74
43	4.65	0.82
44	4.83	0.80
45	5.73	0.77
46	5.05	0.79
47	5.23	0.75
48	5.50	0.75
49	5.65	0.78
50	4.78	0.80
51	5.15	0.73
52	5.40	0.73
53	5.45	0.70
54	4.43	0.86
55	4.70	0.78
56	5.25	0.75
57	5.28	0.78
58	5.18	0.76
59	6.05	0.69

Observação: O pacote kableExtra fornece várias comandos para Editar suas Tabelas. Neste Link: De Hao Zhu, tem várias dicas para personalização de tabelas pelo pacote.

15.1.4 Histograma para verificar a distribuição dos dados da variável resposta

P.S.: Com o comando echo, Você mostra o resultado, mas não o chunk.

15.1.5 Tabela Descritivas de Média e Desvio Padrão

Com o comando get_summary_statsé possivel obter dados descritivos (média e desvio padrão) do seu banco de dados. Com a função kabledo pacote, monta-se o cabeçalho da tabela, e com a função kable_styling, defini-se a fonte e o tamanho da fonte.

resumo <- tb %>% 
  get_summary_stats(densidade, type = "mean_sd")

kable(resumo,
      col.names = c("Densidade", "n", "Média", "Desvio Padrão")) %>%
  kable_styling(full_width = F, html_font = "Times", font_size = 20)

Densidade	n	Média	Desvio Padrão
densidade	59	0.761	0.06

15.1.6 Gráfico com a regressão e ajuste da reta linear

Autor: Henfil.↩︎

Criar um arquivo R Markdown

24 março, 2022

1 Criar um novo arquivo

2 Nomear o arquivo

3 Aparência do R Markdown

4 Salvar o novo arquivo

5 Escolher a pasta e nomear o arquivo

6 Visualizar o novo arquivo em HTML

7 Aparência do Novo arquivo em HTML

8 Inserir sumário

9 Numeração de seção

10 Aparência e estilo

11 Deixar a data automática

12 Inserir um logo ou imagem antes do Título

13 Elementos básicos do RMarkdown

13.1 Títulos

13.2 Formatação

13.3 Adicionando links

13.4 Adicionando imagens

13.5 Criando notas de rodapé (clicáveis)

13.6 Listas não-ordenadas

13.7 Adicionando equações

13.8 Incluindo códigos R

14 Salvar Documentos em RMarkdown

14.1 Visualizar o documento em HTML e salvar em formato HTML

15 Exemplo de Relatório

15.1 Estimativa de Densidade Básica utilizando o Pilodyn

15.1.1 Pacotes Utilizados

15.1.2 Importar os dados

15.1.3 Ver o Banco de dados

15.1.4 Histograma para verificar a distribuição dos dados da variável resposta

15.1.5 Tabela Descritivas de Média e Desvio Padrão

15.1.6 Gráfico com a regressão e ajuste da reta linear