Plantilla memoria proyectos URJC con R Markdown

Este proyecto de RStudio proporciona una plantilla para crear una memoria de TFG o TFM de la URJC, usando R Makdown y LaTeX. La misma plantilla puede ser fácilmente adaptada para la redacción y publicación de una tesis doctoral en URJC.

La base es una plantilla para proyectos URJC con XeLaTeX publicada en GitHub, así como en un repositorio del GitLab de la OfiLibre URJC.

La principal ventaja que ofrece esta versión es que te permite trabajar directamente en R/RStudio para realizar, simultáneamente, la parte técnica de tu proyecto y la redacción de la memoria. Con eso se ahorra mucho tiempo y se evita duplicar esfuerzos (por ejemplo, guardando gráficas o resultados para incorporarlos al documento de la memoria, formatearlos, etc.). Mediante esta plantilla, todo el proceso queda automatizado a través de las funciones de R Markdown y el paquete bookdown, entre otros. Esto también es posible gracias a Pandoc, el conversor universal de documentos, que se encarga de todo el trabajo pesado de traducción del contenido Markdown a PDF.

Ejemplo de memoria

Aquí tienes un ejemplo de como queda el documento de la memoria.

Instrucciones de uso

Lo más sencillo es hacer un fork de este repositorio para obtener tu propia copia, sobre la que ya podrás trabajar directamente. Es conveniente que renombres el repositorio de tu copia con un identificador apropiado, por ejemplo TFG-NombreApellidos o TFM-NombreApellidos. Por último, clona el repositorio en tu máquina local y abre el proyecto en RStudio para comenzar a trabajar.

Puedes consultar información adicional en estos enlaces:

• Introducción a R Markdown.
• Tutoriales sobre R Markdown.
• R Markdown: The Definitive Guide.
• R Markdown Cookbook.
• bookdown: Authoring Books and Technical Documents with R Markdown.

Requisitos software previos

En el directorio /fonts encontrarás los archivos de tipografías necesarias para instalarlas en tu equipo, en caso de que aún no las tengas.

Si quieres compilar la memoria utilizando esta plantilla en tu propio sistema, necesitas tener primero instalados los programas necesarios.

• Una distribución completa de LaTeX, por ejemplo Tex Live. Si usas Linux, busca en el gestor de paquetes de tu distribución los paquetes que necesitas instalar.

• La plantilla incorpora el paquete minted, para resaltado de sintaxis de fragmentos de código. Para que funcione, debes tener instalado Python, junto con el paquete Pygments.

• Además, recuerda que cualquier fuente tipográfica que quieras utilizar en el documento debe ser una fuente OpenType o TrueType compatible y estar previamente instalada en tu sistema, para que se pueda insertar en el documento. Las fuentes se pueden configurar fácilmente en las opciones del preámbulo del archivo index.Rmd.

  Inicialmente, las fuentes usadas son:

  • mainfont: "TeX Gyre Pagella" Descarga;
  • sansfont: "Lato", de Google Fonts;
  • monofont: "Source Code Pro", de Google Fonts;
  • mathfont: "TeX Gyre Pagella Math" Descarga, licencia;
  • fuente para títulos: "Montserrat", de Google Fonts.

Todas estas fuentes están disponibles públicamente, con licencia libre.

Compilación de la memoria PDF

Una vez instalados todos los requisitos previos, puedes compilar el documento pulsando el botón Build Book de la pestaña Build del panel Environment/History, tal y como muestra la siguiente animación.

Características principales

Esta plantilla está preparada para generar tu memoria en formato PDF utilizando XeTeX, un motor de tipografía que se invoca mediante el comando xelatex. XeTeX está instalado en la mayoría de distribuciones LaTeX modernas, tales como TeX Live. Este motor incorpora algunas características novedosas:

• Usa por defecto codificación UTF-8.
• Soporta fuentes Open Type instaladas en tu sistema.
• Permite usar fuentes Unicode con características matemáticas especiales, como Asana Math o TeX Gyre Pagella Math.
• Permite utilizar iconos representados como fuentes tipográficas, como Font Awesome, instalados en el sistema.
• Utiliza polyglossia, un paquete de reglas tipográficas y traducción de términos a lenguas diferentes del inglés, alternativo a babel para XeLaTeX y LuaTeX y mucho más potente.

Además, la plantilla utiliza BibLaTeX como paquete de gestión de referencias bibliográficas, en sustitución del tradicional BibTeX. BibLaTeX, junto con el gestor de backend biber, soporta codificación UTF-8 de forma nativa y posee muchas características potentes para manejar referencias en documentos.

Informes de error y peticiones de mejoras

Por favor, utiliza el sistema de seguimiento de errores del proyecto (Issues, en el menú superior de esta página), si quieres reportar algún error que hayas encontrado o solicitar nuevas funciones o mejoras.