-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.Rmd
198 lines (172 loc) · 7.43 KB
/
index.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
---
# -----------------------
# General config
# -----------------------
title: "Título del proyecto"
subtitle: "Subtítulo del proyecto"
author: "John Doe"
director: "Dr. José Felipe Ortega Soto"
date: "`r Sys.Date()`"
year: "2022"
degree: "GRADO EN INGENIERÍA _____"
academic-course: "2021/2022"
doc-type: "Trabajo Fin de Grado"
subject: "Report subject metadata"
keywords: ['key1', 'key2', 'key3']
school: "ETSIT"
university: "Universidad Rey Juan Carlos"
country: "Spain"
# -----------------------
# Doc class, KOMA config options
# -----------------------
site: bookdown::bookdown_site
documentclass: scrbook
classoption: [
twoside, # Two-side layout
openright, # Always start chapter on even page
#titlepage, # Include title page
parskip=half+, # Inter-paragraph spacing (half[+-] | full[+-])
numbers=noenddot, # Remove end dot in headers numbering
#chapterprefix=true, # Include prefix for chapter headings
#appendixprefix=true, # Include prefix for appendix headings
headinclude=true, # Include page header
footinclude=true, # Include page footer
cleardoublepage=empty, # Empty page to fill double-page layout
BCOR=5mm, # Set binding correction if necessary
#DIV=calc # Calc. grid divisions for optimal page layout
#mpinclude=true, # width = textwidth
usegeometry=true # Let typearea translate layout changes to geometry
]
geometry: "verbose" # Must also set usegeometry=true above
geometry-wide-side: true # Wide side column for marginal notes
geometry-debug: no # If 'yes' shows geometry frames
bibliography: [book.bib, packages.bib]
lang: "es-ES" # Examples: "en" | "en-US" | "en-UK"
polyglossia-lang:
name: "spanish"
options:
variant=spanish
# -----------------------
# Typography
# -----------------------
mainfont: "TeX Gyre Pagella"
mainfontoptions: "Scale=0.96"
sansfont: "Lato"
sansfontoptions: "Scale=0.9"
monofont: "Source Code Pro"
monofontoptions: "Scale=0.9"
mathspec: yes
mathfont: "TeX Gyre Pagella Math"
mathfontoptions: "Scale=0.96"
fontfamilies:
- name: \headerfont
font: Montserrat
options:
- Scale=MatchUppercase
- name: \partfont
font: Montserrat
- name: \chapterfont
font: Montserrat
- name: \sectionfont
font: Montserrat-SemiBold
- name: \subsectionfont
font: Montserrat-Medium
- name: \subsubsectionfont
font: Montserrat-Medium
# -----------------------
# Links
# -----------------------
verbatim_in_note: yes
colorlinks: yes
linkcolor: "Firebrick4"
citecolor: "Aquamarine4"
urlcolor: "RoyalBlue3"
# -----------------------
# Frontmatter
# -----------------------
toc: yes
lot: yes
lof: yes
lolists: yes
# url: your book url like https://bookdown.org/yihui/bookdown
# cover-image: path to the social sharing image like images/cover.jpg
description: |
This is a minimal example of using the bookdown package to write a book.
The HTML output format for this example is bookdown::bs4_book,
set in the _output.yml file.
# -----------------------
# Bibliography
# -----------------------
biblio-style: apalike
csl: chicago-fullnote-bibliography.csl
---
# Prefacio {-}
Este proyecto ofrece una plantilla para escribir la memoria de un TFG o TFM con
el formato solicitado por la ETSIT de la URJC. El formato es también compatible
con las memorias para la ETSIT y puede ser compatible (quizá con mínimos cambios)
con otras escuelas y facultades (ESCET, FCS, etc.).
El proyecto nace para ofrecer soporte a la redacción de documentos científicos,
utilizando [**R Markdown**](https://rmarkdown.rstudio.com/), que permite integrar
contenido formateado en *Markdown* con código ejecutable en lenguaje R.
Este es un libro de _ejemplo_, creado mediante los paquetes [`rmarkdown`](https://pkgs.rstudio.com/rmarkdown/) y
[`bookdown`](https://pkgs.rstudio.com/bookdown/). A su vez, el contenido generado
en formato Markdown se pasa a la herramienta [Pandoc](https://pandoc.org/), un
traductor universal de documentos. Por tanto, el contenido puede incluir cualquier
elemento soportado por Pandoc, como una expresión matemática \(a^2 + b^2 = c^2\).
La gran ventaja de usar estas herramienta es que todos los resultados numéricos
y gráficos de nuestro código R se podrán insertar automáticamente en nuestro
documento, evitando la tediosa tarea de copiar y pegar los resultados, o actualizarlos
en caso de que ejecutemos una nueva versión.
## Utilización {-}
Cada capítulo **bookdown** en un archivo .Rmd, que contiene un (y solo un) capítulo.
Es **obligatorio** que cada capítulo comienze por un encabezado de primer nivel en
Markdown: `# Título de un capítulo`, y que contenta un (y solo un) encabezado de
este nivel.
Se pueden usar el segundo nivel y los siguientes niveles de encabezado dentro de los
capítulo, como: `## Título de sección` o `### Título de subsección`. Como en cualquier
otro documento, no se recomienda usar encabezados más allá del tercer nivel, salvo
en casos muy justificados. Jamás se debería usar encabezados más allá del cuarto nivel.
Es un requisito obligatorio que exista un archivo `index.Rmd`, que contiene (como
en este ejemplo) el primer capítulo del libro. Fíjate que, en este ejemplo, se ha
elegido que sea un prefacio no numerado. Se puede conseguir un encabezado no numerado
de cualquier nivel agregando tras el título del encabezado y espacio en blanco, seguido
del código `{-}`. En el caso de que la salida sea un documento HTML, este capítulo
será la página de inicio (*home*) del proyecto.
## Representación del libro {-}
Otra de las grandes ventajas de usar R Markdown y Pandoc es que el mismo formato
de documento se puede representar en tres posibles formatos de salida diferentes.
### Formato HTML {-}
Genera páginas web, normalmente con una barra lateral para navegar por los capítulos.
Se puede generar la versión HTML de un documento R Markdown sin cambiar nada.
1. Enccuentra en la IDE RStudio el panel **Build** (normalmente, en el panel del
cuadrante superior derecho).
2. Pulsa en el triángulo negro del botón **Build Book** (con el icono de un martillo),
para desplegar una lista de formatos y elegir el que quieres construir, o selecciona
"All formats" para crear un libro en múltiples formatos de salida con los mismos
ficheros de entrada.
También se puede representar el libro desde la consola R:
```{r, eval=FALSE}
bookdown::render_book()
```
### Formato PDF {-}
Para construir un documento PDF a partir de este libro, se necesita seleccionar el formato
de salida `bookdown::pdf_book`. En este caso, necesitas tener instalada previante una
distribución de **LaTeX**, un sistema de composición tipográfica, que incluye herramientas
para generar este tipo de salida, como [pdfTeX](https://es.wikipedia.org/wiki/PdfTeX) o
[XeTeX](https://es.wikipedia.org/wiki/XeTeX).
Se recomienda instalar TinyTeX (que incluye XeTeX): <https://yihui.org/tinytex/>.
## Previsualización del libro {-}
Conforme trabajas, se puede ejecutar un servidor local para previsualizar el resultado
del libro en formato HTML. Esta previsualización se actualizará conforme se edita el
libro, cuando guardas cada archivo individual .Rmd. Puedes arrancar el servidor en una
sesión de trabajo usando el add-in "Preview book" de RStudio, o bien desde la línea
de comandos:
```{r eval=FALSE}
bookdown::serve_book()
```
```{r include=FALSE}
# automatically create a bib database for R packages
knitr::write_bib(c(
.packages(), 'bookdown', 'knitr', 'rmarkdown'
), 'packages.bib')
```