URGE: The easiest way to create a great ReadMe file for your dataset

Abstract

(Watch the RECORDING.)

“Reproducibility is the cornerstone of science” [1] – and FAIR is a cornerstone in reproducibility, we might add. The aim of FAIR research data and research data management is maximizing the reuse of data [2]. Achieving this goal hinges on the clear and detailed documentation of both the data and its metadata to ensure datasets are easily understandable and reusable by researchers and end-users alike. It also requires an open scientific infrastructure, available for the global research community [3]. A ReadMe plays a key role in this process by providing essential context and instructions for users. This becomes even more important since many archival platforms have limited space for detailed metadata and documentation.

Despite its significance, creating a ReadMe remains a challenge for researchers uploading datasets, research data curators and certainly for end-users attempting to interpret them. This difficulty stems from the reliance on traditional text-based ReadMe templates, which typically include structured questions with guidance provided in parentheses. Researchers must manually fill in the relevant fields, remove unnecessary text and help instructions, and format the file into a user-friendly document. Consequently, fully describing and curating a ReadMe file demands significant time and effort. Moreover, traditional ReadMe files are designed solely for human readability, making them unsuitable for big data applications and AI technologies. These limitations highlight the URGEnt need for improved tools and approaches to streamline the ReadMe file creation process.

To tackle these challenges, we developed URGE (Universal Readme GEnerator), an innovative tool that not only overcomes the shortcomings of traditional templates but also redefines the process of creating ReadMe. Designed with user-friendliness in mind, URGE enables the production of detailed, comprehensive ReadMe files that adhere to FAIR principles. It saves time by automatically importing most dataset information from sources such as draft datasets from Dataverse, USN Research Data Archive, Sikt DMP, or previously stored ReadMe files. Users can then supplement this data with additional details using customized text boxes and then generate a complete and well-structured ReadMe file. URGE can also upload the generated file directly to the archive servers, eliminating the need for manual downloads. When necessary, an anonymized version can be prepared for double-blind peer-reviewed publications. Additionally, URGE can produce machine-readable JSON ReadMe files, making datasets more compatible with artificial intelligence and automated processes that positions it as a forward-thinking solution for modern research data management.

In our view, URGE will not only improve and simplify the process of creating a ReadMe file, but also serves as a driving force in the development of the ReadMe file, making it a definitive “must have” document in complying with the FAIR principles and best practice in Open Science.