Skip to content

๐Ÿ  Introduction

ClarID-Tools

Welcome to the documentation for ClarID-Tools

๐Ÿ“ Description

ClarID-Tools is a flexible, schema-driven toolkit for generating and parsing structured identifiers for subject and biosample data. The objective is to standardize how subject and biosample metadata are encoded into compact, informative IDs for downstream integration and tracking.


๐Ÿ”ฌ 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