-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy path091-markdown.Rmd
249 lines (148 loc) · 7.47 KB
/
091-markdown.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
## Markdown {#markdown}
Se você é uma pessoa que utiliza R, sabe das possibilidades de utilizar R Markdown (e os pacotes que expandem mais ainda as possibilidades) e gostaria de começar a utilizá-lo, é importante conhecer o Markdown. Por quê? O R Markdown tem como base a linguagem de marcação [Markdown](https://www.markdownguide.org/).
Os arquivos markdown podem ser abertos por qualquer software que suporte este formato aberto. Além disso, independente da plataforma de trabalho, pode-se migrar para um arquivo de texto sem perder a formatação. O Markdown também é usado em outros lugares, como no [GitHub](https://github.com/) e no [Fórum da Curso-R](https://discourse.curso-r.com).
Uma referência interessante para ter sempre em mãos é a Folha de cola (*Cheatsheet*) do [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet).
Nas seções seguintes, descreveremos como podemos marcar os nossos textos e códigos usando `markdown`, e você poderá usar isso tanto em arquivos `.Rmd`, quanto em outros lugares que também utilizam essa marcação (como no [Fórum da Curso-R](https://discourse.curso-r.com)!).
### Ênfase
#### Negrito {-}
Para destacar um texto em negrito, coloque `**` ou `__` ao redor do texto.
Por exemplo:
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
|`Esse é um texto com uma palavra destacada em **negrito**.`| Esse é um texto com uma palavra destacada em **negrito**.|
|`Esse é um texto com uma palavra destacada em __negrito__.`| Esse é um texto com uma palavra destacada em **negrito**.|
#### Itálico {-}
Para destacar um texto em itálico, coloque `*` ou `_` ao redor do texto.
Por exemplo:
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
|`Esse é um texto com uma palavra destacada em *itálico*.`| Esse é um texto com uma palavra destacada em *itálico*.|
|`Esse é um texto com uma palavra destacada em _itálico_.`| Esse é um texto com uma palavra destacada em *itálico*.|
#### Riscado (ou tachado) {-}
Para riscar/tachar um texto, coloque `~~` ao redor do texto.
Por exemplo:
Esse é um texto com uma palavra ~~riscada/tachada~~.
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
|`Esse é um texto com uma palavra ~~riscada/tachada~~.`| Esse é um texto com uma palavra ~~riscada/tachada~~.|
### Títulos
Os títulos funcionam como uma hierarquia, e para criar um título é necessário colocar um `#` no início da linha. Então um `#` marca um título, `##` marca um sub-título, e assim sucessivamente. Veja os exemplos:
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
| `# Título 1` <br> `## Título 2` <br> `### Título 3` | `r knitr::include_graphics("assets/img/relatorios/titulos.png")`|
### Listas
#### Listas ordenadas {-}
Você pode fazer uma lista ordenada usando somente números. Você pode repetir o número quantas vezes quiser:
Como é escrito no código:
> `1. Maçã`
>
> `1. Banana`
>
> `1. Uva`
Como aparece no relatório:
> 1. Maçã
> 1. Banana
> 1. Uva
#### Listas não ordenadas {-}
Você pode fazer uma lista não ordenada escrevendo com hífens ou asteriscos, como a seguir:
>
>
> `* Maçã`
>
> `* Banana`
>
> `* Uva`
>
>
> `- Maçã`
>
> `- Banana`
>
> `- Uva`
O resultado será:
>
> - Maçã
> - Banana
> - Uva
Você também pode adicionar sub-itens na lista indicando a hierarquia através da identação no Markdown (dica: utilize a tecla `tab` do teclado):
>
> - Frutas
> - Maçã
> - Banana
> - Uva
### Equações
Você pode adicionar equações utilizando [LaTeX](https://pt.wikipedia.org/wiki/LaTeX).
Você pode saber mais na [página do Overleaf sobre expressões matemáticas](https://www.overleaf.com/learn/latex/mathematical_expressions).
Além disso, existem [geradores de equações online](https://www.codecogs.com/latex/eqneditor.php?latex=D) que ajudam a escrevâ-las em LaTeX, HTML, entre outras linguagens de marcação.
É possível centralizar a equação envolvendo o código com `$$`. Veja o exemplo abaixo:
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
|`$$y = \mu + \sum_{i=1}^p \beta_i x_i + \epsilon$$`| $$y = \mu + \sum_{i=1}^p \beta_i x_i + \epsilon$$ |
Também é possível adicionar a equação na mesma linha que o texto, envolvendo o código com `$`. Veja o exemplo abaixo:
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
|`Ou também na linha $y = \mu + \sum_{i=1}^p \beta_i x_i + \epsilon$ , junto ao texto!`| Ou também na linha $y = \mu + \sum_{i=1}^p \beta_i x_i + \epsilon$ , junto ao texto! |
### Código
É possível __marcar textos para que fiquem formatados como códigos__, usando a crase: `
Mas atenção: o texto será __formatado como código__, porém não será executado!
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
|`` `mean(pinguins$massa_corporal, na.rm = TRUE)` `` | `mean(pinguins$massa_corporal, na.rm = TRUE)` |
Também é possível delimitar um trecho maior de código, utilizando três crases.
__Exemplo:__
__Como é escrito no código:__
````md
```
library(dados)
mean(pinguins$massa_corporal, na.rm = TRUE)
```
````
__Como aparece no relatório:__
```
library(dados)
mean(pinguins$massa_corporal, na.rm = TRUE)
```
### Links
- Você pode criar um link utilizando esta estrutura:
`[texto](http://url-da-pagina.com)`.
Por exemplo:
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
|`Você pode consultar mais [materiais sobre R nesta página](https://curso-r.com/material/).`| Você pode consultar mais [materiais sobre R nesta página](https://curso-r.com/material/).|
### Imagens
Você pode incluir uma imagem utilizando esta estrutura:
``.
Não se esqueça: a descrição da imagem é importante para
acessibilidade do conteúdo através de leitores de tela!
| Como é escrito no código | Como aparece no relatório |
|--:|--:|
|``| |
### Tabelas
As tabelas em Markdown têm uma estrutura definida, como mostra o exemplo abaixo.
É possível usar ferramentas online para gerar tabelas em Markdown, como por exemplo o [Tables Generator](https://www.tablesgenerator.com/markdown_tables).
__Em Markdown:__
```{}
| a| b| c|
|--:|--:|--:|
| 1| 2| 3|
| 2| 3| 4|
```
__Resultado:__
>
>
> | a| b| c|
> |--:|--:|--:|
> | 1| 2| 3|
> | 2| 3| 4|
### Recapitulando
Nesta seção, aprendemos que o Markdown é uma linguagem de marcação, usada para marcar textos. Podemos usar o Markdown para formatar textos e adicionar elementos no nossos relatórios.
Porém existem elementos (como código, imagens, tabelas, entre outros) que podemos também adiconar nos relatórios utilizando R. É isso que veremos na seção seguinte!
### Exercícios {- #exercicios-md}
**1.** Leia a primeira página o [guia de referência do RMarkdown](https://rstudio.com/wp-content/uploads/2015/03/rmarkdown-reference.pdf)
**2.** Liste abaixo outros lugares que utilizam o Markdown como base (Dica: outras linguagens de programação, fóruns, aplicativos de mensagem, etc)
**3.** Qual é o output se você criar uma lista ordenada começando no 2? Por exemplo:
2. primeiro item
2. segundo item
2. terceiro item
**4.** O que são os _sabores_ de Markdown (Markdown flavor)?
**5.** Experimente o pandoc no [site de demonstração da ferramenta](https://pandoc.org/try/).