Published September 10, 2025 | Version 2025.10
Software Open

Codebook Generator App

  • 1. ROR icon Digital Research Alliance of Canada

Description

The Codebook Generator is an open-source web application designed to help researchers and data managers create structured and standardized codebooks for tabular datasets in formats such as CSV, TSV, and Excel. It provides an interactive, browser-based interface to automatically extract variable names, detect types, identify missing values, and summarize value ranges or factor levels. Researchers can then annotate variables with human-readable labels and units, facilitating transparency, reuse, and interoperability of scientific data.

This app was developed in R using the Shiny framework and is fully client-side when deployed via ShinyLive, ensuring data privacy—no data is stored or transmitted during use. The app supports best practices for research software sustainability. Its design was inspired by the FAIR principles and aims to support reproducible research workflows.

Documentation, usage instructions, and contribution guidelines are included in the project repository. A quick-start tutorial and architecture overview are also available to guide new users and developers.

Repository: https://github.com/Alliance-RDM-GDR/RDM_Codebook_App
Try it online: https://alliance-rdm-gdr.github.io/RDM_Codebook_App/

Abstract (French)

Le Générateur de dictionnaires de données est une application web open source conçue pour aider les chercheurs et gestionnaires de données à créer des dictionnaires de données (codebooks) structurés et normalisés à partir de jeux de données tabulaires (CSV, TSV, Excel). Elle propose une interface interactive accessible via un navigateur, qui permet d'extraire automatiquement les noms de variables, de détecter les types, d’identifier les valeurs manquantes et de résumer les plages de valeurs ou les niveaux de facteurs. Les utilisateurs peuvent ensuite annoter les variables à l’aide de libellés compréhensibles et d’unités, favorisant ainsi la transparence, la réutilisation et l’interopérabilité des données scientifiques.

L’application est développée en R à l’aide du framework Shiny et fonctionne entièrement côté client lorsqu’elle est déployée avec ShinyLive, garantissant la confidentialité des données — aucune donnée n’est stockée ni transmise pendant l’utilisation. L’interface respecte les bonnes pratiques en matière de durabilité des logiciels de recherche. Son développement s’inspire des principes FAIR et vise à soutenir des pratiques de recherche reproductibles.

La documentation, les instructions d'utilisation et les lignes directrices pour les contributions sont disponibles dans le dépôt Git. Un tutoriel de démarrage rapide et une présentation de l’architecture logicielle y sont également proposés.

Dépôt GitHub : https://github.com/Alliance-RDM-GDR/RDM_Codebook_App
Essayer en ligne : https://alliance-rdm-gdr.github.io/RDM_Codebook_App/

Files

alliance_logo.png

Files (248.6 kB)

Name Size Download all
md5:a866204af9be7d5b0bdca039e15f367d
216.1 kB Preview Download
md5:976c51e3ec4c92b72901af7817ad3497
14.5 kB Download
md5:9c29649b3ddabd92ea30e0bb569308f1
2.5 kB Preview Download
md5:9872b3be79292fe61ed85618f66a7952
672 Bytes Download
md5:d0044d07d23eec1cbeeca3dceb32fe73
281 Bytes Download
md5:a4bd43cefa5a3007cfa07519fb5bbc44
2.4 kB Preview Download
md5:6714d0cff405a76ea72bdba99519d9d6
866 Bytes Download
md5:dbea59347ca82077cc2f591a43a88a0c
237 Bytes Download
md5:6d681f7aee024328e96b0d48b6c8925e
1.1 kB Download
md5:12845896d360e5a99448207395cd9032
1.4 kB Preview Download
md5:54835979b3e9eceb298cae690a4be01b
8.0 kB Preview Download
md5:5fc76beab9986c68cb2d5020a3a66329
65 Bytes Preview Download
md5:0b7159475ac09ff2d5ff4d74c5439185
483 Bytes Download

Additional details

Additional titles

Translated title (French)
Générateur de dictionnaires de données

Software

Repository URL
https://github.com/Alliance-RDM-GDR/RDM_Codebook_App
Programming language
R
Development Status
Active