1.2 Pasos
El primer paso consiste es obtener la carpeta de ejemplo tesisfacsodown, luego reemplazar algunos contenidos y obtener el documento formateado mediante un simple click en RStudio. Existen dos formas:
- simplemente bajar la carpeta desde aquí
- para quienes tengan una cuenta en Github, lo más facil es hacer un fork del repositorio https://github.com/juancarloscastillo/tesisfacsodown, luego clonarlo localmente y comenzar a trabajar desde ahí. Esta opción es la más convieniente si se quiere luego publicar la tesis online (detalles abajo en sección de publicación web).
Una vez que se tiene la carpeta localmente, hacer doble click en el archivo tesis.Rproj, con lo que se abrirá RStudio (tiene que estar instalado previamente, tutorial aquí). En RStudio hacer click sobre el botón “build book”:
Figura 1.2: Generando los documentos en pdf y html
Con esto aparecerá en el visor de RStudio (pestaña Viewer) el documento en formato (html) y también se generará el documento tesis.pdf en la carpeta docs, y al que se puede acceder desde el ícono pdf en la barra superior del documento en html. Lo que aparece en los documentos html y pdf es este mismo documento pdf/html que están viendo ahora, pero que ahora se encuentra guardado localmente en sus computadores y que pueden modificar con los contenidos de sus trabajos.
Detalles
La carpeta tiene una serie de archivos y subcarpetas. Lo que hace el botón “build book” es activar la función bookdown de R que permite convertir el contenido escrito en Markdown hacia html y pdf. Para ello, los contenidos de la carpeta se organizan de la siguiente manera:
- Archivo index.Rmd: este archivo contiene
- una serie de campos para poder personalizar e identificar la tesis, como título, autor, etc.
- de manera opcional se puede incluir un archivo con referencias bibliográficas .bib en caso de utilizar formato
bibtex(que puede ser generado con gestores de referencias como Zotero o Mendeley, mayores detalles revisar aquí. - también aparecen algunas opciones que tienen que ver con la generación del documento pdf y del sitio que no hay que modificar.
- finalmente, en este archivo también se puede incluir el Resumen / abstract del trabajo.
- Secciones del trabajo: es una propuesta de archivos markdown con extensión .Rmd que comienzan con un número, y es donde se separan las distintas secciones o capítulos. Podría también ser un solo gran archivo con todos los contenidos, pero esta división permite un mayor orden en el trabajo y también separa en distintas páginas web en el caso de publicación en este formato. El orden en que aparecen las secciones en el documento final se indica con un número al inicio del archivo (ej: 01-intro.Rmd). Los archivos de las secciones que aparecen en esta carpeta son solo de ejemplo y pueden ser eliminados / reemplazados de acuerdo a la estructura preferida.
Adicionalmente se encuentran:
Archivos Readme (.md y .html): contienen la información que aparece aquí, pueden ser eliminados posteriormente.
Archivos .yml: son _output y _bookdown, y contienen información para generar los documentos pdf y html, no modificar
tesis.Rproj: este es archivo que permite acceder a RStudio desde esta carpeta y activar las funciones necesarias para generar el documento formateado. Por lo tanto, luego de bajar la carpeta hacer doble click en este archivo.
tesis.bib: es el archivo que contiene las referencias bibliográficas en formato bibtex, en caso de utilizar esta forma de referenciar. El archivo debe mantenerse con este nombre, de lo contrario no funcionará en el pdf.
Carpetas:
- images: para guardar imágenes que luego se puedan llamar desde los documentos. Para poder insertarlas desde los documentos Rmd se requiere dar la ruta a la imagen, por ejemplo: images/mi_imagen.jpg. Que las imágenes se encuentren en esta carpeta es opcional, solo ayuda al orden de los documentos.
- templates: aquí se encuentran archivos que permiten dar formato a los documentos pdf y html (no modificar ni eliminar)
- docs: carpeta producida automáticamente que contiene los documentos generados y formateados en pdf y/o html.