Guión: uso de la plantilla para hacer un TFG

Github
Plantilla TFE
Autor

Pedro L. Luque

Fecha de Publicación

11 noviembre 2021

Enlaces de interés para el seguimiento de este guión:

Pasos a seguir

  • Ver mi página web con información: libro pdf, plantilla zip, y vídeos.

  • Abrir RStudio e iniciar un proyecto con el git de mi repositorio: “https://github.com/calote/MemoriaTFE”

  • Compilar con knit sobre tfe_principal.Rmd para que vean el pdf con el trabajo fin de grado construido como ejemplo.

  • Abrir la portada para cambiar el nombre-título (“portadas/latex_paginatitulo_modTFGE.tex” o “portadas/latex_paginatitulo_modTFDGME.tex”)

  • Abrir el resumen en español (“resumen.Rmd”) y en inglés (“abstract.Rmd”), y escribir algo.

  • Ocultar algunos de los apartados (prólogo, lista de figuras/tablas, capítulos, apéndices) que no se usarán. Nota: utilizar la opción de menú de RStudio: “Code” > “Comment/Uncomment Lines”.

  • Abrir un capítulo (“capitulo01.Rmd”, “capitulo02.Rmd”, …) y escribir algo.

    • Hacer knit sobre el libro entero.
    • Luego ver el capítulo solamente.

  • Cambiarle el nombre a la carpeta y al proyecto RStudio para que si se sube a la cuenta de Github del alumno se pueda (se verá más adelante):

    • Crear repositorio (con ayuda del token).
    • Recordar cómo se hace la conexión del proyecto RStudio con Github.
    • Y hacerlo privado y añadir cómo colaborar a otra persona (por ejemplo al tutor).

  • Cómo se hace:

    1. cambiar el tamaño de fuente del documento entero,

    2. versiones para imprimir (ver: “tfe_principal_imprimir2caras.pdf”) y para subir a internet (ver: “tfe_principal_librodigital.pdf”)

    3. crear un “job” en un fichero R que tenga la instrucción para crear pdf completo del TFG con ayuda de “jobs de RStudio”:

      rmarkdown::render('tfe_principal.Rmd',  encoding = 'UTF-8')

    4. etc

  • Cómo añadir contenido al TFG (utilizar el fichero con ejemplos: “capitulo05.Rmd”):

    1. fórmulas matemáticas con LaTeX,

    2. notas a pie de página (use: texto^[texto en pie de página]),

    3. añadir enlaces a páginas de internet,

      Nota: incluir antes del primer chunk de código R del fichero “tfe_principal.Rmd” la siguiente instrucción para obligar a que los enlaces se vean como notas a pie de página (sobre todo en la versión para imprimir):

      \renewcommand{\href}[2]{#2\footnote{\url{#1}}}

    4. añadir un gráfico (fichero de captura-imagen o creado con R),

    5. añadir una tabla,

    6. añadir referencias a gráficos, tablas, etc

    7. añadir bibliografía:

      • Estilos de citación en “R Markdown Cookbook”

      • toBibtex(citation("xaringan"))

      • knitr::write_bib(c(.packages(), "bookdown"), "packages.bib"). Nota: .packages() devuelve los nombres de todos los paquetes cargados en la sesión actual de R.

      • Cómo citar (sin el símbolo @ cuando se usa \cite{}):

        En este trabajo se ha usado el paquete "knitr" (ver: [@R-knitr] y [@knitr2015])...

Como aparece en [@R-ahp, páginas 1 a 3], los métodos multicriterio ....

Como aparece en [@cheng2002analytic]

Funciona: \cite{R-knitr,R-base} para múltiple.

El uso del menos para el "año": `[-@R-base]` equivale a : \citeyear{R-base}.

  • Cómo subirlo-conectarlo con Github:

    • Información útil en:

    • Consultar el repositorio remoto con el que está conectado (en terminal de RStudio):

      • git remote show origin
      • o: git remote -v

    • Abrir el fichero “.git/config” (desde RStudio ir a: “Panel Files” > “More” > “Show Hidden Files” para ver ficheros ocultos), borrar las líneas siguientes y grabar el fichero.

      [remote "origin"]
url = https://github.com/calote/MemoriaTFE
fetch = +refs/heads/*:refs/remotes/origin/*
      • Reiniciar el proyecto RStudio (después no funcionará el push aunque esté activo el botón).

    • A continuación ejecutar el código de “usethis” para conectar el proyecto RStudio con Github:

      library(usethis); 
usethis::use_github()

      Debe aparecer lo siguiente a lo que se responderá: “3” (se abrirá la página del nuevo repositorio, al haber cambiado el nombre del proyecto será el puesto: “https://github.com/calote/MemoriaTFGPedroLuque”)

      > library(usethis)
> usethis::use_github()
ℹ Defaulting to 'https' Git protocol
✓ Setting active project to '/Users/calvo/Qsync/TD/MemoriaTFGPedroLuque'
There are uncommitted changes and we're about to create and push to a new GitHub repo
Do you want to proceed anyway?

1: Nope
2: Negative
3: Definitely

Selection: 3

    • Convertirlo en privado.

      • En Github, pulsamos en “Settings” > “Options”,
      • vamos al final donde nos aparece la opción (en “Danger Zone”) de convertirlo en privado: “Change repository visibility” > “Make private”,
      • escribir el texto que nos indica para confirmar: “calote/MemoriaTFGPedroLuque” y nos pedirá que introduzcamos la contraseña en Github.

Comentarios

Comentarios curso 2021/2022

Clase 1 (1 hora aproximadamente)

  • Lo hice creando un proyecto RStudio Git y utilizando la url de mi repositorio: MemoriaTFE. Esto se trae toda la información del histórico de Git que para los alumnos puede que no sea interesante (sí mantiene la codificación utf-8 del proyecto).

    1. Más conveniente y limpio sería descargar el zip de la plantilla, cambiarle de nombre a la carpeta y fichero proyecto (TFGPedroLuque o algo así), abrir el proyecto RStudio, y luego activar el “Git”. Después se puede conectar con Github, con “usethis::use_github()”.

    2. Descargar del repositorio con download no trae el histórico de git, ni tampoco trae el Git activado. Se podría hacer lo mismo que lo comentado en el subapartado (2)

  • No me dio tiempo a ver el apartado: “Cómo añadir contenido al TFG”. Tan solo mencioné algo de los ficheros de bibliografía en la carpeta “bib” y mostrar cómo es el formato BibTeX.

  • No conté la creación de un fichero R como job para crear pdf completo.

  • La cabecera yaml del principal y de capítulos ¿se puede simplificar más?

  • NOTAS A TENER EN CUENTA:

    • Cuidado si se usa .package() en write_bib(), ya que creará la referencia bibtex “R-base” que ya está en “library.bib” (solución: en library.bib, ponerle “R-base2”).

    • Sería conveniente aclarar cómo poner bibliografía numerada (en el repositorio mejorar la documentación sobre ese tema).

    • Sería conveniente revisar cómo se lleva la plantilla con el editor visual de RStudio.

    • Se puede cambiar el nombre también del fichero “tfe_principal.Rmd” por algo más reconocible como “TFGPedroLuque.Rmd”.

    • Revisar por qué no se muestra en la bibliografía en primer lugar la cita de 2019 y luego la de 2017 en las referencias a Pedro L. Luque-Calvo.

    • Pensar en aclarar cómo funciona el fichero “.gitignore”.