Skip to main content

Module provenance

Module provenance 

Source
Expand description

The deterministic provenance of a run (run in the results) and its diagnostics.

Everything recorded here can change the results or is needed to interpret them: the tool version, every parameter with its origin, the alphabet decision, the input’s identity, what validation found, and the references of the methods that ran. Nothing here depends on the machine, the time or the thread count, so identical inputs give identical bytes.

Structs§

DiagnosticInputs
Inputs of diagnostics.

Constants§

SOFTWARE_REFERENCE_KEY
Key of the reference to this software in run.references.

Functions§

alphabet_info
Alphabet provenance.
diagnostics
The diagnostics of a run, in report order.
entropy_info
Entropy settings of the run.
estimator_references
Citation keys of an estimator.
metadata_info
Header-metadata provenance.
references
The references of a run: the DiMA paper, this software, Shannon entropy, the estimator, the coverage estimate, the motif definitions and, where used, alphabet detection and nucleotide ambiguity codes (D89).
validation_info
Validation provenance.