Automatizando la creación de informes: generando grupos de informes utilizando conjuntos de parámetros.
30 de enero de 2023
3 de junio de 2024
Evidentemente Quarto sirve para hacer informes, perfecto!! Hasta ahora, con un fichero .qmd hemos hecho un único informe, pero imagina que tienes que hacer un puñado de informes, todos muy parecidos pero que difieren en algunos aspectos; por ejemplo, puedes necesitar hacer un informe para cada mes o cada año, o un informe para cada cliente/estudiante/etc …, o un informe con distintos datasets o que difieran en algunos supuestos.
En el contexto de Quarto a esta situación de la conoce como “Render parametrised reports”, y nos permitirá generar de forma “automática” un puñado de informes personalizados para cada grupo o situación. Vamos a ello. Aquí la documentación oficial.
Los informes parametrizados permiten modificar/personalizar el informe según los valores de determinados parámetros. Se trata de que en el momento de procesar (render) nuestro fichero .qmd se puedan pasar diferentes valores de ciertos parámetros de forma que se creen versiones diferentes de “un mismo” informe. Por ejemplo, los informes parametrizados pueden usarse para proporcionar a los estudiantes de un curso un informe con sus notas o crear un informe para cada cliente o zona.
Básicamente, solo hay que hacer dos cosas:
Definir la opción params: en el YAML del documento .qmd
Incorporar los parámetros cuando hagas el render de los documentos
No parece muy costoso, pero vamos por partes.
params: en el YAMLEn este caso hemos definido un parámetro llamado “nombre” que tomará como valor por defecto “Pedro”; es decir, si no cambiamos el valor por defecto de “nombre”, ese será el valor que tomará cuando se haga el render del fichero .qmd.
Repito, cuando se haga el render del fichero .qmd, se usará el valor del parámetro “nombre”, y aprenderemos a cambiar el valor de ese parámetro de manera “automática” para generar informes para distintos valores del parámetro; es decir, para distintos estudiantes.
Además, hay que saber que el valor del parámetro que se usará durante el render puede ser accedido dentro del fichero .qmd. El valor del parámetro estará en params$nombre y podremos usarlo en los chunks de código y también como código inline. Si en un chunk de código ponemos por ejemplo: filter(notas, estudiante == params$nombre), si utilizamos el valor por defecto del parámetro, quedará como filter(notas, estudiante == "Pedro") y los cálculos, el informe, se hará utilizando sólo los registros del estudiante Pedro.
Incluso podemos usar más de un parámetro en el YAML. Por ejemplo:
Con el anterior YAML podrían hacerse informes personalizados de, por ejemplo, presupuesto de distintos municipios para diferentes años, utilizando la misma plantilla o documento .qmd.
Nos queda ver cómo podemos ir variando los valores de los parámetros a la hora de procesar el documento .qmd.
Se puede hacer de varias maneras pero la más intuitiva es (una vez tenemos nuestro documento .qmd que hace de plantilla para el informe) usar un bucle con for para procesar la plantilla para diferentes valores de los parámetros.
Supón que tenemos la plantilla en el archivo plantilla.qmd con el siguiente YAML:
y que queremos hacer un informe personalizado para 4 estudiantes, en ese caso, el proceso quedaría como1:
estudiantes <- c("Pedro", "Concha", "María", "José")
nn_estudiantes <- length(estudiantes)
for (ii in 1:nn_estudiantes){
my_estudiante = estudiantes[ii]
quarto::quarto_render(
input = "plantilla.qmd",
output_file = paste0("notas-", my_estudiante, ".pdf"),
execute_params = list(nombre = my_estudiante)
)
}Lógicamente habría que ejecutar el chunk anterior desde un script de R.
Haremos una práctica sobre informes parametrizados durante el curso. I promise!!
Yo ya había hecho unos cuantos informes parametrizados, incluso un año, lo enseñé en clase, pero para redactar este post me he basado en (Helveston 2023) y (GW Coders 2023). Entre otras cosas, me enteré de que Quarto tiene problemas, fácilmente superables, para usar data.frames como parámetros y para hacer el render en una carpeta diferente de la raíz del Qproject (!!).
Ya en 2024, Jadey Ryan hizo un workshop para R-Ladies D.C. El título del workshop es Parameterized reporting using Quarto y está disponible la charla de casi 2 horas y el repo. Va a repetir el workshop en febrero de 2024 en R-Ladies Abuja. Jadey Ryan ya dio una charla de 20 minutos sobre el tema en posit::conf(2023), el vídeo aquí, 20 minutos. Además tiene un repo para hacer informes parametrizados en su organización. Este package fue revisado en directo por Luke Terney, vídeo aquí
Aquí, una preciosura de slides en las que se hace algo parecido; bueno en realidad usa child documents para crear unas slides donde hay una slide para cada persona de una organización.
Si quieres hacer el render con parámetros desde la Terminal :
Aquí un post de Meghan Hall sobre informes parametrizados con énfasis en la personalización de los PDFs.