Laboratorio de estadística con R, II.

Comandos básicos de la sintaxis de Markdown.

1. R Markdown.

1.1. ¿Qué es R Markdown?

R Markdown puede definirse como un ecosistema dentro de R y R Studio que permite la elaboración de diversos tipos de textos (documentos de texto, presentaciones, aplicaciones basadas en texto), y que permmite la integración de elementos diferentes como texto (en formato Markdown, código de R, resultados de análisis derivados de dichos códigos, así como formato de acuerdo a las necesidades de los autores, lo que se delimita en la sección de los metadados o YAML).

1.2. Partes de un documento en formato Rmarkdown.

Un documento en formato rmarkdown() está integrado por 3 partes:

1. *YAML** (Yet Another Markdown Language), que contiene los metadatos del documento.
2. La sección de texto enriquecido, donde el autor presenta la redacción deseada, utilizando las características de escritura de markdown.
3. Las secciones de código de R, que se pueden integrar mediante dos maneras:

1. a través de chunks o “trozos” de código,
2. a través de código dentro de cada línea de texto en la redacción.

2. Markdown

2.1. ¿Qué es Markdown?

Es un lenguaje de “marcado ligero” creado por John Gruber en el año 2004 que trata de lograr o permitir facilidad en la lectura y en la escritura de documentos, evitando distracciones y complicaciones, y que puede ser renderizado (transformado) en diversos formatos.
Es una manera de simplificar la escritura en la era digital, en donde se debe publicar el mismo texto en formatos diferentes. De manera más concreta, Markdown es una sintaxis que permite incorporar elementos de texto enriquecido en elementos de texto plano.

El texto enriquecido consiste en caracteres de texto a los que se les añade formato (negritas, cursivas, subrayado, interlineado, espacios entre palabras, etc.). El texto plano solo consiste en letras, números, signos de puntuación y algunos símbolos, sin elementos de formato.  La sintaxis consiste en el sistema para utilizar símbolos y caracteres, que le explican al procesador de una computadora la manera en que se deben realizar algunas tareas y, específicamente se refiere a la apariencia deseada del texto.

2.2. Ventajas de escribir en formato Markdown.

1. Enfocarse en la escritura y no procrastinar con elementos de formato.
2. Permite exportar el contenido de Markdown a formatos diversos (html, pdf, word, web pages).
3. Los archivos se pueden abrir en cualquier formato, aún cuando en el futuro cambien los programas de texto.
4. Los archivos son “ligeros” y fáciles de sincronizar entre distintos dispositivos.
5. Facilidad para compartir y colaborar.
6. Las citaciones se pueden autoformatear.

2.3. Elementos de sintaxis en Markdown

2.3.1. Resaltar texto

• Si se desea resaltar una palabra en negritas e itálica a la vez, se usa triple *** antes y después de la palabra.
  

palabra en ***negritas e itálica***

• Si se desea resaltar una palabra en negritas se usa doble ** antes y después de la palabra.
  

palabra en **negritas**

• Si se desea resaltar una palabra en itálicas se usa un * sencillo antes y después de la palabra.
  

palabra en *itálicas*

• Si se desea incluir un sub índice se utiliza la tilde de la “ñ”, de manera que F₂.
  

incluir el subíndice 2 en F:  F~2~

• Si se desea incluir un super índice se utiliza el acento circunflejo, de manera que F².

incluir el super índice 4 en F:  F^2^

2.3.1.1. Cambiar de color al texto.

Esto depende del tipo de formato de salida: html o pdf, pues se usan comandos diferentes.

• Para html, el texto a cambiar de color se incluye en <span> y posteriormente <span style="color: red;">texto</span>, por ejemplo:

Roses are <span style="color: green;">red</span>, violets are <span style="color: red;">blue</span>.

El resultado es:

Roses are red, violets are blue.

• Para un pdf, se usan comandos de LaTeX \textcolor{color}{texto}, de manera que, por ejemplo:

Roses are \textcolor{red}{red}, violets are \textcolor{blue}{blue}.

El primer paréntesis refiere el color deseado y el segundo contiene el texto sobre el que se debe aplicar el color.

El resultado es:

Roses are , violets are .

2.3.2. Apartados y sub apartados.

Para asignar apartados y sub apartados se utiliza el signo de “#” (número). El apartado inicial o mayor se indica con solo un signo “#”, y a medida que se aumenta la cantidad de signos, entonces se van posicionando como sub apartados, y el tamaño de la tipografía va decreciendo.
Por ejemplo:

1. Apartado principal. (1 #)

1.1. Primer partado secundario. (2 ##)

1.1.1. Sub apartado primero del Primer apartado secundario. (3 ###)

1.1.1.1. Sub sub apartado primero del Primer apartado secundario. (4 ####)

1.1.2. Sub apartado segundo del Primer apartado secundario. (3 ###)

1.2. Segundo apartado secundario. (2 ##)

2. Segundo apartado principal. (1 #)

2.3.2.1. Omitir encabezados.

En caso de desear que un encabezado (que comience con “#” no sea incluido en la ennumeración o listado correspondiente) se utiliza el script {.unlisted .unnumbered} después del título señalado con ““#”, de la siguiente manera:

# Section heading {.unlisted .unnumbered}

2.3.3.Listados.

En R Markdown se pueden realizar dos tipos o formatos de listas: ordenadas o numeradas y las no ordenadas.

La realización de listados ordenados se realiza anteponiendo el número y un espacio antes de cada texto, además de dejar un espacio entre el párrafo previo y el inicio del listado, por ejemplo:

1.  El primer elemento.
2.  El segundo elemento.
3.  El tercer elemento.
4.  Etc.

El resultado es:

1. El primer elemento.
2. El segundo elemento.
3. El tercer elemento.
4. Etc.

También se pueden ordenar utilizando letras:

a.  Primer elemento
b.  Segundo elemento
c.  Tercer elemento

El resultado es:

1. Primer elemento
2. Segundo elemento
3. Tercer elemento

En caso de realizar un listado sin jerarquía o numeración, solo se coloca un “*” o un guión intermedio “-” y un espacio antes de cada texto:

-   Primer elemento.
-   Segundo elemento.
-   Tercer elemento.
-   Etc.

El resultado es:

• Primer elemento.
• Segundo elemento.
• Tercer elemento.
• Etc.

Otra opción son listados mezclados, para lo que se usa dos “tab” para los sub elementos:

1.  Primer elemento

2.  Segundo elemento

    1.  Primer sub elemento (incluye dos "tab")
    2.  Segundo sub elemento (incluye dos "tab")

3.  Tercer elemento

    -   Otro sub elemento no ordenado (incluye dos "tab")
    -   Otro sub elemento no ordenado (incluye dos "tab")

El resultado es:

1. Primer elemento

2. Segundo elemento

   1. Primer sub elemento (incluye dos “tab”)
   2. Segundo sub elemento (incluye dos “tab”)

3. Tercer elemento

   • Otro sub elemento no ordenado (incluye dos “tab”)
   • Otro sub elemento no ordenado (incluye dos “tab”)

2.3.4. Separación.

2.3.4.1. Renglones continuos.

La manera de escribir un párrafo en R Markdown es a partir de ubicar el cursor en una línea numerada y, así, continuar escribiendo sin detenerse hasta el punto final. A medida que el párrafo sea cada vez más largo, automáticamente el texto irá bajando de líneas, pero ahora estas no están numeradas. R Mardown lee estas líneas no-numeradas como parte de un mismo párrafo, y no hace cortes ni saltos.

Aún si se da un solo “click” a la tecla “ENTER”, y en el visor de R Markdown se cambia de línea numerada, en el caso del “output” (html, pdf o word) no habrá ocurrido un salto de párrafo, sino que continua como parte de un mismo párrafo. Por ejemplo:

"Este es el párrafo de la línea 80.
Este es el párrafor de la línea 81."

El resultado es:
“Este es el párrafo de la línea 80. Este es el párrafo de la línea 81.”

2.3.4.2. Separación entre renglones.

Para lograr laseparación entre líneas o “saltar líneas seguidas” dentro de un mismo párrafo, se utiliza un “doble espacio” al final del renglón que se desea separar (dos veces a la barra espaciadora); también se puede utilizar una barra diagonal palabra final.\, “\” al final del renglón. Por ejemplo:

"Este es el párrafo de la línea 85.\
Este es el párrafor de la línea 86".

El resultado es: “Este es el párrafo de la línea 85.
Este es el párrafo de la línea 86.”

2.3.4.3. Separación entre párrafos.

Para separar párrafos entre sí se deja una línea numerada vacía entre ambos, por ejemplo:

""Por segundo año consecutivo, la mayoría de los programas sociales del
Gobierno de López Obrador tuvieron en 2020 un bajo desempeño y algunos
de ellos operaron también en condiciones de opacidad.

Así lo revela el Índice de Desempeño de los Programas Públicos Federales
2021 (INDEP) elaborado por la organización Agencia para el Desarrollo (...)."

El resultado es:

“Por segundo año consecutivo, la mayoría de los programas sociales del Gobierno de López Obrador tuvieron en 2020 un bajo desempeño y algunos de ellos operaron también en condiciones de opacidad.

Así lo revela el Índice de Desempeño de los Programas Públicos Federales 2021 (INDEP) elaborado por la organización Agencia para el Desarrollo (…).” (Ureste, 2021, 3 de noviembre de 2021)

2.3.5. Insertar un salto de página.

Para insertar un salto de página se utiliza el script \newpage, que es parte del lenguaje de LaTeX pero que, a su vez, reconoce el paquete de rmarkdown.

Por ejemplo:

"Contenido de página 1. \newpage 
Contenido de página 2."

“Contenido de página 1. Contenido de página 2.”

2.3.4. Insertar citas largas en párrafos separados.

En caso de una cita larga y de la que se desea separar un bloque de texto, se utiliza el signo de \> y se añade un “espacio” antes del inicio del párrafo, por ejemplo:

> Entre los programas con un escaso desempeño hay algunos de los
considerados 'estrella' en la presente administración, como Sembrando
Vida, el programa de reforestación con el que el Gobierno actual ha
dicho que busca combatir los efectos del cambio climático en México.
Otros con bajo rendimiento son el de Becas para personas con
discapacidad, y el programa de Universidades para el Bienestar Benito
Juárez. Por el contrario, el programa de Pensión para Adultos Mayores
está entre los que mejor rendimiento han tenido.

El resultado es:

Entre los programas con un escaso desempeño hay algunos de los considerados ‘estrella’ en la presente administración, como Sembrando Vida, el programa de reforestación con el que el Gobierno actual ha dicho que busca combatir los efectos del cambio climático en México. Otros con bajo rendimiento son el de Becas para personas con discapacidad, y el programa de Universidades para el Bienestar Benito Juárez. Por el contrario, el programa de Pensión para Adultos Mayores está entre los que mejor rendimiento han tenido.

2.3.4.1. Insertar sangrías.

Una manera “cruda” de colocar sangría es mediante la tecla | al inicio de un párrafo. Se debe recordar que markdown no reconoce los espacios en blanco, o los ignora y junta renglones separados. Por ello se le debe indicar el lugar de los espacios vacíos a manera de sangrías.

| When dollars appear it's a sign
|   that your code does not quite align  
| Ensure that your math  
|   in xaringan hath  
|   been placed on a single long line

El resultado es:

When dollars appear it’s a sign
  that your code does not quite align
Ensure that your math
  in xaringan hath
  been placed on a single long line

2.3.5. Notas al pie.

Para insertar notas al pie se utilizan, primero, los paréntesis cuadrados [], adentro se coloca el signo ^1 y se añade un identificador.
Aparte, en cualquier parte del texto, se añade la misma sintaxis, se agrega un signo de “:” (dos puntos) y se añade el texto de la nota al pie, por ejemplo:

"Por ejemplo, para el programa Beca Universal para Estudiantes de
Educación Media Superior Benito Juárez, uno de los dos incluidos en la
'Caja Negra', el Ejecutivo propone que para el próximo año disponga de
34 mil 999 millones de pesos, es decir, 4% más [^1] que el presupuesto
aprobado en este 2021." (Ureste, 2021, 3 de noviembre)

[^1]: Esta nota es mía y no se encuentra en el texto original.

El resultado es:

“Por ejemplo, para el programa Beca Universal para Estudiantes de Educación Media Superior Benito Juárez, uno de los dos incluidos en la ‘Caja Negra’, el Ejecutivo propone que para el próximo año disponga de 34 mil 999 millones de pesos, es decir, 4% más ¹ que el presupuesto aprobado en este 2021.” (Ureste, 2021, 3 de noviembre)

2.3.6. Tablas de contenido.

En Markdown es posible incluir tablas en formato sencillo, y se elaboran manualmente mediante el uso de signos ‘|’ para separar columnas y los guiones intermedios ‘-’ para separar la fila de encabezado respecto de las filas con contenido.
En el caso de desear incluir un título a la tabla, al final de ésta se incluye el signo ‘:’ y posteriormente se redacta el título, por ejemplo:

| Número |       Ítem       |
|:------:|:----------------:|
|   1    | primer elemento  |
|   2    | segundo elemento |
|   3    | tercer elemento  |

: Aquí se escribe el título de la tabla

El resultado es:

Aquí se escribe el título de la tabla

Número	Ítem
1	primer elemento
2	segundo elemento
3	tercer elemento

La página tables generator es una alternativa de apoyo para generar tablas en formato markdown.

2.3.7. Incluir una dirección de URL.

Esto se logra a partir de dos elementos: primero se refiere el nombre o etiqueta de referencia, y se ubica entre paréntesis cuadrados [etiqueta] y a continuación se incluye la dirección URL ubicada entre paréntesis ().  Por ejemplo:

[página web de tables generator](https://www.tablesgenerator.com/markdown_tables)

El resultado es:

página web de tables generator

En caso de desear que se visualice la liga URL completa, entonces se usan los signos de < > al inicio y al final de la dirección URL, por ejemplo:

la página "tables generator" `<https://www.tablesgenerator.com/markdown_tables>`.

Esta es la liga URL de la página “tables generator” <https://www.tablesgenerator.com/markdown_tables>.

2.3.8. Incluir una imagen en el texto.

Esto se logra a partir de varios elementos: ! + [etiqueta] + (ruta de acceso a la imagen dentro del disco duro).

Por defecto, R Markdown buscará la imágenes dentro del directorio de trabajo en que se encuentra enraizado, por lo que, si la imagen se encuentra dentro del mismo directorio entonces solo se requiere escribir el nombre del archivo de imagen dentro de los paréntesis, incluyendo el formato del archivo de imagen (ya sea .jpg, .jpeg, .pdf, .png u otro).

![imagen dentro del directorio de trabajo](intervalo_confianza.png)

El resultado es:

En caso de que la imagen se encuentre fuera del directorio de trabajo pero, a su vez, se encuentra dentro del disco duro, entonces sí se debe escribir la ruta de acceso al archivo de imagen dentro de los paréntesis.

![imagen dentro del disco duro](~/Dropbox/R/Rmarkdown/prueba_uso_markdown_files/imagen_prueba.png)⁩

El resultado es:

Otra opción para insertar imágenes es a partir de “traer” al texto archivos que se encuentran ubicados en internet, para ello se requiere señalar la dirección URL del archivo de imagen, lo que se escribe dentro de los paréntesis.

![imagen en
URL](https://economipedia.com/wp-content/uploads/Captura-de-pantalla-2019-09-10-a-les-11.09.35.png)

El resultado es:

imagen en URL

2.3.8.1. Controlar el tamaño de las imágenes.

Hay diversas maneras de controlar el tamaño de las imágenes. Aquí se revisa la manera de hacerlo directamente sobre el comando que inserta una imagen (en vez de hacerlo desde el “chunk” de código).
Para ello se utiliza el comando del lenguaje Markdown: ![nombre del objeto](path/to/image.png) y posteriormente se le añade el argumento que define su tamaño mediante los argumentos {width = 50%} o {height = 50%}, de la siguiente manera:

![nombre del objeto](path/to/image.png){width = 50% height=50%}

Por ejemplo:

El tamaño original de la imagen es:

Y se solicita el cambio de tamaño al 50% de la imagen original, de la siguiente manera:

![imagen dentro de directorio de
trabajo](poblacion_muestra.png){width="50%" height="50%"}

imagen dentro de directorio de trabajo

2.3.9. Incluir comentarios en el texto sin que aparezcan en el “output”.

Para incluir comentarios en el texto y que no aparezcan en el “output” se incluye el script <!-- your comment -->, y el texto puede tener una o varias líneas de longitud. También existen “shortcut” con el teclado para incluir el script: Ctrl + Shift + C (Command + Shift + C enmacOS). Por ejemplo:

"Por ejemplo, para el programa Beca Universal para Estudiantes de
Educación Media Superior Benito Juárez <!-- Debo comprobar los datos sobre esta política educativa -->, uno de los dos incluidos en la
'Caja Negra', el Ejecutivo propone que para el próximo año disponga de
34 mil 999 millones de pesos, (...)."

El resultado es: “Por ejemplo, para el programa Beca Universal para Estudiantes de Educación Media Superior Benito Juárez , uno de los dos incluidos en la ‘Caja Negra’, el Ejecutivo propone que para el próximo año disponga de 34 mil 999 millones de pesos, (…).”

3. Ejercicio.

Instrucciones: Elabora la redacción de un texto, puede ser de tu autoría propia o citado de alguna otra fuente.
A partir de dicho texto, modifícalo como tu desees, pero utiliza la mayoría de las opciones de sintaxis revisadas en este documento.
Incluye alguna imagen en el documento, puede estar vinculada temáticamente o no. Inserta la imagen en su formato original y posteriormente vuelve a insertarla en un tamaño menor. Finalmente, guarda el archivo en el formato .Rmd.

---

1. Esta nota es mía y no se encuentra en el texto original.↩︎