¿Por qué incluir un archivo Readme en un conjunto de Datos de Investigación es una buena práctica?

¿Qué es un Readme?

Un archivo Readme es un complemento simple, pero muy importante a la hora estructurar un conjunto de Datos de Investigación. Se trata de un documento de texto que funciona como una guía para la comprensión de los datos.

Este tipo de archivo contiene información esencial que un investigador podría necesitar para comprender, analizar o reutilizar el conjunto de datos ya sea el periodo que comprende la recopilación de los datos, el significado de las abreviaturas o especificaciones técnicas relacionadas a los formatos de los archivos. Si bien los metadatos describen el conjunto de datos dentro del repositorio, el archivo Readme permite ofrecer información contextual adicional. Por ejemplo, las Notas de uso en el Formulario de Datos del SIGEVA tienen como fin especificar el software que requiere un archivo para su ejecución, en este caso un archivo Readme puede incluir detalles técnicos y específicos del software para su correcta utilización.

¿Qué contiene un archivo Readme?

Dryad menciona que un Readme debe proporcionar a los equipos de investigación, tanto dentro como fuera de su disciplina, el contexto suficiente para interpretar, validar o reutilizar un conjunto de Datos de Investigación. Los mismos pueden contener:

• Descripción general de la estructura de archivos y carpetas.
• Descripción de las etiquetas de archivos y columnas.
• Contenido detallado sobre las variables, códigos de datos y unidades de medida.
• Detalles del procesamiento y análisis, como el software.

¿En qué formato debe guardarse un archivo Readme?

Los archivos Readme deben ser accesibles y legibles a largo plazo. Por este motivo, se recomienda utilizar formatos abiertos y preservables como TXT (.txt) o Markdown (.md), que pueden ejecutarse con cualquier editor de texto, por lo que no dependen de un software específico.

Complementar los conjuntos de Datos de Investigación con archivos Readme bien estructurados favorece el cumplimiento de los principios FAIR, al hacer que los datos sean más fáciles de encontrar, accesibles, interoperables y reutilizables. De esta manera, los conjuntos de datos alcanzan su máximo potencial dentro de la comunidad científica, promoviendo la transparencia y la colaboración.