~!gurí_

Gestor Unificado de formatos para Revistas de Investigación

~!gurí_ es una propuesta que facilita la etapa de producción editorial de revistas científicas, mediante la generación de documentos finales a partir de documentos obtenidos de la etapa de 'revisión de pares' en formato docx. Para ello, esta propuesta se centra en el paquete de R {guri}, el cual se encarga de coordinar el proceso de generación de los documentos finales en diferentes formatos.

Esta propuesta busca resolver las dificultades que atraviesan algunas revistas académicas de acceso diamante para la generación de documentos finales en diferentes formatos de forma consistente, evitando procesos duplicados y altos costos editoriales. Además, toma en cuenta que muchas revistas científicas utilizan como base de sus flujos de trabajos documentos docx.

La propuesta propone esquematizar y separar los principales elementos que componen un artículo científico. Para ello, para cada artículo, se debe generar un archivo docx (generado mediante una plantilla predefinida y con las citas identificadas con Zotero) y un archivo yaml con los metadatos del artículo. Opcionalmente, puede brindarse otros archivos con información de la taxonomía CRediT, elementos flotantes (figuras y tablas) y apéndices. A partir de estos archivos iniciales se genera un archivo intermedio markdown, que se utiliza para generar los documentos finales (en formato pdf, html y xml). Además, esta herramienta permite generar un archivo xml para el depósito de DOI en Crossref. Por su diseño, la propuesta permite una fuerte adaptación y personalización para que pueda ser adaptado a las particularidades y estética de cada revista.

De forma resumida, podemos señalar que la propuesta de ~!gurí_ se compone de dos aspectos que trabajan de forma coordinada: un flujo de trabajo y un conjunto de herramientas de programación. Por un lado, la propuesta exige adoptar un flujo de trabajo, que incluye una determinada organización de archivos y carpetas, así como el plantillado de los manuscritos siguiendo un conjunto de reglas predefinidas. Por otra parte, la propuesta se basa en un conjunto de herramientas de programación que se encargan de la creación de los documentos finales en los diferentes formatos. Gran parte de este trabajo se hace con Pandoc, que es utilizado 'debajo del capó' para la conversión entre formatos de marcado. Para adaptar Pandoc a las necesidades de la edición académica, se utilizan un conjunto de filtros Lua y plantillas personalizadas. Por su parte, LaTeX se utiliza para generar los archivos en formato pdf. Por último, la propuesta utiliza el lenguaje de programación R para coordinar y 'envolver' todo el proceso. En términos prácticos, todo este proceso es coordinado por el paquete de R {guri}.

Documentación

Una descripción de la propuesta puede encontrarse en la documentación de usuario.

Dependencias de software

Para el uso de esta herramienta se requiere tener previamente instalado R (recomendable versión 4.3 o superior), siendo recomendable tener instalado el entorno de desarrollo RStudio, el cual facilita el trabajo con R. Si bien para el funcionamiento de la propuesta se utilizan otros programas, el paquete de R {guri} se encarga de la instalación de estas dependencias (ver guri_install()). En este sentido, como parte de la configuración de {guri} el paquete instalará Pandoc y una distribución de LaTeX denominada tinytex, la cual tiene una robusta integración con R, facilitando la instalación de los paquetes de LaTeX que hicieran falta.¹

Instalación

Deberá instalar {guri}. Para esto puede hacerlo desde r-universe de la siguiente manera:

options(repos = c(
    estedeahora = 'https://estedeahora.r-universe.dev',
    CRAN = 'https://cloud.r-project.org'))
install.packages('guri')

También puede hacerlo directamente desde el repositorio github, para lo cual puede utilizar {remotes} o {pak} según usted prefiera.

# install.packages("remotes")
remotes::install_github("estedeahora/guri")

# or

# install.packages("pak")
pak::pkg_install("estedeahora/guri")

Una vez instalado {guri} deberá cargar el paquete e instalar las dependencias externas (Pandoc y Tinytex). Este proceso puede tardar unos minutos y requiere una conexión estable a internet.

library(guri)
guri_install()

Licencia

~!gurí_ puede usarse como parte del proceso de producción de revistas de acceso diamante (revistas sin cobro de cargos de procesamiento y sin muros de pago). Más allá de esta restricción, no existe ningún límite salvo la atribución de autoría. En este sentido, se solicita que si su revista utiliza esta herramienta como parte de su proceso editorial agregue el siguiente texto dentro de su página web (habitualmente dentro de la sección de 'política editorial') en los diferentes idiomas que utilice en la revista:

Español:
Los documentos finales de esta revista fueron generados utilizando ~!guri_.

English:
The final documents of this journal were generated using ~!guri_.

Português:
Os documentos finais desta revista foram gerados usando ~!guri_.

Esta herramienta está bajo una licencia Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License. Este software no ofrece garantía de ningún tipo.

Contribuir

Se aceptan solicitudes de extracción, informes de errores y solicitudes de funciones. Utilice los issues para informar errores o solicitar funciones.

Futuras mejoras

1. Transformar funciones en paquete de R.
2. Permitir filtros personalizados.
3. Agregar soporte para permitir primer idioma diferente de español.
4. Permitir salida para depósito DOI en Crossref.
5. Desarrollar aplicación web para facilitar la generación de archivos yaml.
6. Integrar con OJS.
7. Posibilitar uso desde línea de comando (y luego desde aplicación).
8. Ofrecer múltiples templates como opción con guri_make_journal.
9. Agregar ebook como formato de salida.
10. Incorporar requerimientos de Scielo.

Footnotes

1. De forma predeterminada se instalarán además los siguientes paquetes de LaTeX que son utilizados por la pantilla de Pandoc: amsfonts, amsmath, lm, unicode-math, iftex, listings, fancyvrb, longtable, booktabs, graphicx, hyperref, xcolor, soul, geometry, setspace, babel, xeCJK, fontspec, selnolig, mathspec, biblatex, bibtex, biber, upquote, microtype, csquotes, natbib, bookmark, footnotehyper, footnote, xurl, parskip y svg. A su vez, la adaptación de la plantilla utiliza los siguientes paquetes: adjustbox, fontawesome5, caption, ccicons, relsize, truncate, lastpage y koma-script. ↩