Expand description
Typed analysis results and their JSON representation (schemas/results.schema.json).
Key names follow DiMA (Tharanga et al. 2025) so existing knowledge of the tool carries over;
enumerations serialise to DiMA’s strings. Quantities that are undefined are null, never a
sentinel: entropy at positions without support, ratios with a zero denominator, extrema of an
empty set. The output is deterministic: no timestamps, no absolute paths, a fixed key order.
Structs§
- AllPositions
Summary - The summary over all positions with DiMA v5.0.9’s rule (positions without support count as 0 bits; low-support positions contribute their observed entropy).
- Alphabet
Info - Alphabet provenance.
- Character
Count - Occurrences of one byte value in sequence lines.
- Checksum
- A content checksum.
- Code
Point Count - Code points removed from header values, by code point.
- Coverage
Summary - Sample-coverage summary (Chao & Jost 2012).
- Entropy
Info - Entropy settings.
- Extremum
- An entropy extremum: the first (lowest) position attaining it and how many positions do.
- Field
Counts - Value counts of one header field.
- HcsConfidence
- Confidence-bound settings.
- HcsMember
- A position contributing to a conserved region.
- HcsParameters
- Parameters of an HCS computation.
- HcsRegion
- One historically conserved sequence.
- HcsResults
- Historically conserved sequences of a results file.
- HcsSource
- The results an HCS computation was derived from.
- Header
Cleaning - Header-value cleaning statistics (D59).
- Header
Mismatch - A header whose field count differs from the header format.
- Input
Info - Identity of the analysed input (D47): name, size and checksum of the bytes as stored.
- Metadata
- Counts of each value of each stratified header field among the sequences carrying a
variant, in
--header-formatorder with values sorted by their UTF-8 bytes. - Metadata
Info - Header-metadata provenance (present when a header format was given).
- Mismatches
- Header mismatches: the total and the first ones in full.
- Parameters
- Every parameter with its value and origin.
- Position
Result - Results for one k-mer position.
- Rarefaction
- Settings of the paper’s rarefaction-regression correction as implemented (D51, D55).
- Reference
- A reference cited by the methods used in the run.
- Results
- The complete results of an analysis.
- RunInfo
- Provenance of a run.
- Support
Label Counts - Number of positions in each support class.
- Tool
Info - Name and version of the producing tool.
- Validation
Info - Input validation statistics.
- Variant
- One distinct k-mer at a position.
- Whitespace
Counts - Whitespace found inside sequence lines.
Enums§
- Alphabet
Method - How the alphabet was determined.
- Byte
Class - Class of a sequence byte (see the documentation’s symbol tables).
- Compression
- Compression of the input.
- Entropy
Fallback - Why the requested estimator fell back to the plug-in entropy.
- Entropy
Method - The method that produced a position’s
entropy. - HcsEligibility
- Which positions may contribute to conserved regions.
- Motif
- Diversity motif of a k-mer variant (Hu et al. 2013; Tharanga et al. 2025).
- Support
Label - Low-support class of a position with support N and threshold T (Tharanga et al. 2025): no support (N = 0), low support (0 < N < T), equal to the threshold (N = T). Positions with N > T are eligible and carry no label.
Constants§
- SCHEMA_
VERSION - Version of the results and HCS JSON schemas (SemVer: a reader accepts the same major).