Skip to content

About

ClarID: A Human-Readable and Compact Identifier Specification for Biomedical Metadata Integration

Resources

Stars

2 stars

Watchers

0 watching

Forks

Repository files navigation

ClarID-Tools

ClarID: A Human-Readable and Compact Identifier Specification for Biomedical Metadata Integration

Build and Test Coverage Status CPAN Publish Kwalitee Score version Docker Build Docker Pulls Docker Image Size Documentation Status License: Artistic-2.0 Google Colab


📘 Documentation: https://cnag-biomedical-informatics.github.io/clarid-tools

📓 Google Colab tutorial: https://colab.research.google.com/drive/1smS42yzL7qYV1kCz34baTWLRr_AAap-r

🗂️ Use Cases I & II GDC Data: https://github.com/CNAG-Biomedical-Informatics/clarid-tools/tree/main/nb/data

📦 CPAN Distribution: https://metacpan.org/pod/ClarID::Tools

🐳 Docker Hub Image: https://hub.docker.com/r/manuelrueda/clarid-tools/tags


ClarID-Tools

📝 Description

ClarID-Tools is a toolkit for working with the ClarID specification, including the reference command-line implementation, preprocessing utilities, and example workflows. The objective is to standardize how subject and biosample metadata are transformed into compact, informative IDs for downstream integration, tracking, and exchange.


🔬 Key Features

  • 🧬 Biosample and Subject ID generation from structured metadata
  • 🩺 Support for clinical and experimental metadata, including species, tissue, assay, condition, and more
  • 📄 Human-readable and stub-formatted modes for compact or verbose identifiers
  • 🧪 Bulk and single-record encoding/decoding
  • ✅ Schema validation using JSON Schema and YAML codebooks
  • 📦 Command-line interface

📱 Android Companion App

This repository provides the ClarID-Tools command-line toolkit. For scanning ClarID QR labels on a phone, the separate ClarID-Pocket Android app decodes subject and biosample identifiers offline.

Learn more about ClarID-Pocket · Download the latest APK · Source code


🧠 Citation

If you use ClarID-Tools in your work, please cite:

Rueda, M. and Gut, I.G. (2026). ClarID: a human-readable and compact identifier specification for biomedical metadata integration. Journal of Biomedical Semantics 17, 9. https://doi.org/10.1186/s13326-026-00349-6


👤 Author

Written by Manuel Rueda, PhD. Info about CNAG can be found at https://www.cnag.eu.


📄 License

ClarID-Tools is released under the Artistic License. See the LICENSE file for details.

About

ClarID: A Human-Readable and Compact Identifier Specification for Biomedical Metadata Integration

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages