aboutsummaryrefslogtreecommitdiff
path: root/scripts/genotypes/types.py
blob: 0ac335a5f6347c682d1d1edfa863204efd524b6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
"""The datatypes this package will use."""
from dataclasses import dataclass
from typing import Sequence, Optional


@dataclass
class DotGenoFields:
    """Custom .geno file format values"""
    name: str,
    mat: str,
    pat: str,
    het: str,
    type_: Optional[str] = None
    unk: Optional[str] = None


@dataclass(frozen=True)
class FieldsIdentity:
    """Data type for identity of the fields."""
    marker: str
    chromosome: str
    genetic_distance: str # cM
    physical_distance: str # Mb
    samples: Sequence[str]


@dataclass(frozen=True)
class LineDetails:
    """Data type for processed line details"""
    line_content: Sequence[Union[str, None]]
    geno_symbols: Sequence[str]
    line_header: Optional[str] = None


@dataclass(frozen=True)
class LineError:
    """An error object for a line."""
    marker: str
    field: str
    value: Union[str, None]
    message: str


@dataclass(frozen=True)
class FileStats:
    """Custom file statistics."""
    data_lines: int
    total_lines: int
    geno_symbols: Sequence[str]

    blank_lines: int = 0
    comment_lines: int = 0
    dot_geno_lines: int = 0
    dot_geno_fields: Optional[DotGenoFields] = None
    samples: Sequence[str] = field(default_factory=tuple)
    samples_list: Sequence[str] = field(default_factory=tuple)
    markers_list: Sequence[str] = field(default_factory=tuple)
    errors: Sequence[LineError] = field(default_factory=tuple)