Skip to main content

Module model

Module model 

Source
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§

AllPositionsSummary
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).
AlphabetInfo
Alphabet provenance.
CharacterCount
Occurrences of one byte value in sequence lines.
Checksum
A content checksum.
CodePointCount
Code points removed from header values, by code point.
CoverageSummary
Sample-coverage summary (Chao & Jost 2012).
EntropyInfo
Entropy settings.
Extremum
An entropy extremum: the first (lowest) position attaining it and how many positions do.
FieldCounts
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.
HeaderCleaning
Header-value cleaning statistics (D59).
HeaderMismatch
A header whose field count differs from the header format.
InputInfo
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-format order with values sorted by their UTF-8 bytes.
MetadataInfo
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.
PositionResult
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.
SupportLabelCounts
Number of positions in each support class.
ToolInfo
Name and version of the producing tool.
ValidationInfo
Input validation statistics.
Variant
One distinct k-mer at a position.
WhitespaceCounts
Whitespace found inside sequence lines.

Enums§

AlphabetMethod
How the alphabet was determined.
ByteClass
Class of a sequence byte (see the documentation’s symbol tables).
Compression
Compression of the input.
EntropyFallback
Why the requested estimator fell back to the plug-in entropy.
EntropyMethod
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).
SupportLabel
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).