This is the documentation of DiMA . The newest release is .
This documentation of the development version includes changes that are not released yet. The newest release is .
Symbol tables
Every byte of a sequence line belongs to exactly one class, which depends on the alphabet. The
classes are the values of class in run.validation.characters of the
results. Letters are case-insensitive: lower-case letters are folded to
upper case first (and counted).
| Class | Effect at a position |
|---|---|
residue | part of the k-mer |
gap, missing, ambiguity, stop, frameshift | the k-mer is invalid: that sequence does not count towards the support |
whitespace | ignored (the sequence continues) |
unknown | strict mode: the run stops with record, line and column; permissive and report modes: the k-mer is invalid and the character is counted and reported |
Protein
Section titled “Protein”| Class | Characters | Source |
|---|---|---|
| residue | A C D E F G H I K L M N P Q R S T V W Y | the 20 standard amino acids |
| residue | U (selenocysteine), O (pyrrolysine) | genetically encoded amino acids (Böck et al. 1991; Srinivasan et al. 2002) |
| ambiguity | X (any), B (D or N), Z (E or Q), J (I or L) | IUPAC-IUB one-letter codes |
| gap | - . _ | alignment gaps (Eddy 2011) |
| missing | ~ ? | missing data (Eddy 2011); ? is “no consensus” in LANL alignments (Los Alamos HIV Sequence Database 2009) |
| stop | * $ ^ | * is the usual stop symbol of translations; $ and ^ are stops in LANL alignments (Los Alamos HIV Sequence Database 2009; Los Alamos HIV Sequence Database 2024) |
| frameshift | # | LANL alignments (Los Alamos HIV Sequence Database 2009; Los Alamos HIV Sequence Database 2024) |
| whitespace | space, tab (\t), carriage return (\r), vertical tab, form feed | line formatting; Easel’s FASTA reader ignores the first three in sequence lines (Eddy 2011) |
| unknown | every other byte: digits, other punctuation, the letters not listed above, non-ASCII bytes |
| Class | Characters | Source |
|---|---|---|
| residue | A C G T | |
| residue | U, counted as T | T and U are one symbol; the number folded is reported |
| ambiguity | R Y K M S W B D H V N | IUPAC-IUB nucleotide codes (Cornish-Bowden 1985) |
| ambiguity | X, I (inosine) | “any” and inosine, which pairs with several bases (Martin et al. 1985; Ohtsuka et al. 1985) |
| gap, missing, stop, frameshift, whitespace | as for proteins | |
| unknown | every other byte |
As DNA, with U as the residue and T counted as U.
Bytes that never reach the table
Section titled “Bytes that never reach the table”- The line feed ends a line; a carriage return directly before it is part of the line ending.
- A NUL byte (0x00) anywhere stops the run in every mode: the file is binary or corrupt.
- Header lines (starting with
>) are not sequence data; see header metadata.
Why these choices
Section titled “Why these choices”Folding case, treating T and U as one symbol, excluding stops and frameshifts, and stopping at unknown characters by default are deliberate; the reasons, and the effect on the paper’s HIV-1 pol protein dataset, are in Reading alignments. DiMA v5.0.9 used different rules; see Differences from DiMA v5.0.9.
References
Section titled “References”- Böck A, Forchhammer K, Heider J, Leinfelder W, Sawers G, Veprek B, Zinoni F. Selenocysteine: the 21st amino acid. Molecular Microbiology. 1991;5(3):515-520. doi:10.1111/j.1365-2958.1991.tb00722.x ↩︎
- Cornish-Bowden A. Nomenclature for incompletely specified bases in nucleic acid sequences: recommendations 1984. Nucleic Acids Research. 1985;13(9):3021-3030. doi:10.1093/nar/13.9.3021 ↩︎
- Eddy SR. Accelerated Profile HMM Searches. PLoS Computational Biology. 2011;7(10):e1002195. doi:10.1371/journal.pcbi.1002195 ↩︎ 1 2 3
- Los Alamos HIV Sequence Database. Codes and Symbols in Sequence Alignments. Los Alamos National Laboratory; 2009. https://www.hiv.lanl.gov/content/sequence/HelpDocs/IUPAC.html ↩︎ 1 2 3
- Los Alamos HIV Sequence Database. Gene Cutter Help and Explanation. Los Alamos National Laboratory; 2024. https://www.hiv.lanl.gov/content/sequence/GENE_CUTTER/cutter-help.html ↩︎ 1 2
- Martin FH, Castro MM, Aboul-ela F, Tinoco I. Base pairing involving deoxyinosine: implications for probe design. Nucleic Acids Research. 1985;13(24):8927-8938. doi:10.1093/nar/13.24.8927 ↩︎
- Ohtsuka E, Matsuki S, Ikehara M, Takahashi Y, Matsubara K. An alternative approach to deoxyoligonucleotides as hybridization probes by insertion of deoxyinosine at ambiguous codon positions. Journal of Biological Chemistry. 1985;260(5):2605-2608. doi:10.1016/S0021-9258(18)89400-5 ↩︎
- Srinivasan G, James CM, Krzycki JA. Pyrrolysine Encoded by UAG in Archaea: Charging of a UAG-Decoding Specialized tRNA. Science. 2002;296(5572):1459-1462. doi:10.1126/science.1069588 ↩︎