Expand description
Analysis parameters, their defaults and their validation.
Every default lives here, once; the CLI, the GUI and the documentation read them from this
module. Parameters the user did not set are None and resolve to these defaults (or to a
value derived from the data, such as the k-mer length from the alphabet), and the provenance
records which happened.
Structs§
- Analysis
Params - Parameters of one analysis.
Nonemeans “use the default” (or derive from the data). - Param
- A resolved parameter value with its origin.
- Percent
- An exact decimal percentage, used for thresholds that are compared with count ratios.
Enums§
- Alphabet
- Sequence alphabet.
- Estimator
- Entropy estimator.
- Origin
- Where a parameter’s value came from (recorded in the provenance).
- Parse
Percent Error - Why a percentage could not be parsed.
- Validation
Mode - How characters outside the alphabet are handled.
Constants§
- BATCH_
MAX_ BYTES - Bytes per input batch (upper bound, sequence and header bytes).
- BATCH_
MAX_ RECORDS - Records per input batch (upper bound).
- DEFAULT_
FILL - Default value for empty or missing header fields (DiMA v5.0.9’s
--header-fillna). - DEFAULT_
HCS_ THRESHOLD - Default HCS threshold (per cent): the paper’s default, 100% (Tharanga et al. 2025, Methods).
- DEFAULT_
KMER_ NUCLEOTIDE - Default k-mer length for nucleotides: 27, the coding sequence of a 9-mer.
- DEFAULT_
KMER_ PROTEIN - Default k-mer length for proteins: 9, the length of peptides presented by HLA class I (Falk et al. 1991; Rammensee 1993; Tharanga et al. 2025).
- DEFAULT_
SUPPORT_ THRESHOLD - Default support threshold T (Tharanga et al. 2025, Methods: “default is 100 sequences, arbitrarily defined”; the paper’s Fig. 2 shows 30, DiMA v5.0.9’s default).
- HCS_
THRESHOLD_ MIN_ EXCLUSIVE - Lower bound (exclusive) of the HCS threshold: above 50% the Index variant is unique.
- ID_
DIAG_ MIN_ RECORDS - Minimum number of probed records before a field can be reported as identifier-like.
- MISMATCH_
LOG_ MAX - Maximum number of mismatched headers listed in full.
- PROBE_
MIN_ RECORDS - Minimum number of records examined by the first-batch probe (alphabet, header statistics), when the input has that many.