Skip to main content

Module diagnostics

Module diagnostics 

Source
Expand description

Typed, aggregated diagnostics: conditions that do not stop an analysis but that the user should know about (FastQC/Nextclade-style warnings recorded with the results).

Each condition has a stable Code. Producers count occurrences in a Tally (cheap, mergeable, keeps the first MAX_EXAMPLES examples in input order) and turn the totals into one Diagnostic per condition at the end of the run, so the user sees every condition once, with a count, examples and a hint, rather than a flood of per-record messages.

Structs§

Diagnostic
One reported condition.
Tally
A mergeable count with the first examples in input order.

Enums§

Code
Stable diagnostic codes. The serialised names never change within a schema major version; new codes may be added in minor versions.
Severity
How serious a diagnostic is.

Constants§

MAX_EXAMPLES
Maximum number of examples stored per diagnostic.

Functions§

sort
Orders diagnostics for reporting: by Code order (unknown codes last), keeping the emission order within a code. Deterministic regardless of thread scheduling.