Apéndice 1. Sintaxis de Markdown

Fecha última actualización: 2024-07-14

Muchas de las descripciones de las sintaxis de Markdown que se presentan aquí pueden obtenerse directamente en RStudio, en la sección Markdown quick reference del menú de ayuda de RStudio.

Formato de texto con Pandoc

Formato de negritas, itálicas y código

**negritas**, *itálicas* y `código`

Formato cabeceras de las secciones y subsecciones

 # Título sección
 ## Título subsección
 ### Título subsubsección

Formato listas numeradas

1. item 1
1. item 2

Resultado compilado:

  1. item 1
  2. item 2

Formato listas con puntos

+ item 1
+ item 2

Resultado compilado:

  • item 1
  • item 2

Formato listas anidadas

1. item 1
    + item 1.1 # se dejan 4 espacios en blanco como margen por la izquierda
    + item 1.2
1. item 2

Resultado compilado:

  1. item 1
    • item 1.1
    • item 1.2
  2. item 2

Formato línea horizontal

****

Resultado compilado:

Formato tablas

+---------------+---------------+--------------------+
| A             | B             | C                  |
+===============+===============+====================+
| A0            | B1            | - C10              |
|               |               | - C11              |
+---------------+---------------+--------------------+
| A1            | B2            | - C20              |
|               |               | - C21              |
+---------------+---------------+--------------------+

Resultado compilado:

A B C
A0 B1
  • C10
  • C11
A1 B2
  • C20
  • C21

Construcción de una tabla a partir de una estructura tibble

tibble(
  año=c(1985,2000,2015),
  España=c(38.734,40.75,46.122),
  Francia=c(55.38,59.387,64.395),
  Alemania=c(77.57,81.896,80.689)) %>%
  knitr::kable( caption = "Población anual en millones")
Table 8.1: Población anual en millones
año España Francia Alemania
1985 38.734 55.380 77.570
2000 40.750 59.387 81.896
2015 46.122 64.395 80.689

Formato enlaces web

[enlace web](https://www.google.es/)

Resultado compilado:

enlace web

Formato inserción imagen

![Título imagen](https://ctim.es/Delmond.png){ width=50% }

Resultado compilado:

Título imagen
Título imagen

Códigos en el fichero Markdown

Cabecera del fichero Mardown

---
title: "Mi título del trabajo"
author: "Mi nombre y apellidos"
date: "`r Sys.Date()`"
output: html_document
---

Fragmentos de código (chunks)

La sintaxis de los chunks es la siguiente

```{r, opciones de knitr separadas por comas} 
   código 
```

Opciones de los chunks

  • include = FALSE ni el código ni los resultados aparecen en el archivo compilado. R Markdown aún ejecuta el código en el chunk y los resultados pueden ser utilizados por otros chunks.

  • echo = FALSE el código no aparece en el archivo compilado pero los resultados si.

  • message = FALSE evita que los mensajes generados por el código aparezcan en el archivo compilado.

  • warning = FALSE evita que los warnings generados por el código aparezcan en el archivo compilado.

  • cache = TRUE se guarda la ejecución del chunk y no se vuelve a ejecutar salvo que se modifique. Esto es interesante para acelerar la ejecución del Knit.

  • fig.cap = "..." agrega una leyenda a los resultados gráficos.

  • out.width='60%' establece el ancho de la figura como un porcentaje del ancho de la zona de texto.

  • fig.asp=1.2 establece la proporción alto/ancho de la figura

  • fig.align='center' establce el alineamiento de la figura

Además, podemos asociar una etiqueta (label) a cada chunk escribiendola al principio, a continuación de ```{r. Veamos esto con un ejemplo de una figura de un gráfico de barras. En estos momentos las instrucciones de como se construye el gráfico de barras no son relevantes

```{r chunk-label,fig.cap = "Leyenda figura",out.width='50%',fig.asp=0.8,fig.align='center',cache=TRUE} 
tibble(var=c("A","B","C"),value=1:3) %>%
  ggplot(aes(x=var,y=value,fill=var)) +
    geom_bar(stat = "identity")
```
Leyenda figura

Figure 8.1: Leyenda figura

Si queremos ajustar las opciones por defecto que usarán los chunk podemos poner una instrucción como la siguiente al principio del documento, que hará, que por defecto, el código de los chunk no se incluya en el texto. Esto es interesante cuando queremos generar un texto sin códigos R.

```{r setup, include=FALSE}
knitr::opts_chunk$set(echo = FALSE)

```

Ejecución interactiva del código R

Para depurar los errores de código resulta de interés poder ejecutar el código línea por línea, para ello basta poner el cursor sobre ella y pulsar Ctrl-Enter (en windows y linux), o Cmd-Enter (en Mac). Para ejecutar varias líneas, las podemos seleccionar con el ratón y hacemos lo mismo. Para ejecutar el contenido completo de un chunk basta situar el ratón en cualquier lugar del chunk y pulsar Alt-Ctrl-C (en windows) o Alt-Cmd-Enter (en Mac).