pseqsid 1.1.0

Calculates pairwise sequence identity, similarity and normalized similarity score of proteins in a multiple sequence alignment.
Documentation 
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187

/// Data associated with amino acids

use std::collections::HashSet;
use clap::ArgEnum;

/// Standard amino acids and gap.
pub struct StdAAnGap;

impl StdAAnGap {
    /// Creates a HashSet of standard amino acids and gap as chars.
    pub fn create() -> HashSet<char> {
        let std_aa_gap = "ACDEFGHIKLMNPQRSTVWY-";
        let std_aa_set: HashSet<char> = HashSet::from_iter(std_aa_gap.chars());
        std_aa_set

    }
}

/// Type of matrix to be used for Normalized Similarity Score
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, ArgEnum, Debug)]
pub enum Matrix {
    BLOSUM62,
    PAM250,
    GONNET,
}
 
/// Substitution matrix
/// It will create a modified BLOSUM62, PAM250, or a GONNET
/// depending on the parameters of the new method.
/// This matrices will exclude values for ambiguous residues,
/// such as B, Z and X
pub struct SubstitutionMatrix {
    /// The actual matrix
    data: Vec<Vec<f64>>,

    /// Residues as index of each row and column. The order matters.
    names: Vec<char>,

}

impl SubstitutionMatrix {
    /// Create a new SubstitutionMatrix instance
    /// The instance created will contains the data and name order of
    /// BLOSUM62, PAM250 or GONNET depending on the Matrix value passed
    pub fn new(mat_type: Matrix) -> SubstitutionMatrix {
        match mat_type {
            Matrix::BLOSUM62 => {
                let names: Vec<char> = "ARNDCQEGHILKMFPSTWYV-".chars().collect();
                let data = Vec::from([
                    vec![4.0, -1.0, -2.0, -2.0, 0.0, -1.0, -1.0, 0.0, -2.0, -1.0, -1.0, -1.0, -1.0, -2.0, -1.0,  1.0,  0.0, -3.0, -2.0,  0.0, 0.0],
                    vec![-1.0, 5.0, 0.0, -2.0, -3.0, 1.0, 0.0, -2.0, 0.0, -3.0, -2.0, 2.0, -1.0, -3.0, -2.0, -1.0, -1.0, -3.0, -2.0, -3.0, 0.0],
                    vec![-2.0, 0.0, 6.0, 1.0, -3.0, 0.0, 0.0, 0.0, 1.0, -3.0, -3.0, 0.0, -2.0, -3.0, -2.0, 1.0, 0.0, -4.0, -2.0, -3.0, 0.0],
                    vec![-2.0, -2.0, 1.0, 6.0, -3.0, 0.0, 2.0, -1.0, -1.0, -3.0, -4.0, -1.0, -3.0, -3.0, -1.0, 0.0, -1.0, -4.0, -3.0, -3.0, 0.0],
                    vec![0.0, -3.0, -3.0, -3.0, 9.0, -3.0, -4.0, -3.0, -3.0, -1.0, -1.0, -3.0, -1.0, -2.0, -3.0, -1.0, -1.0, -2.0, -2.0, -1.0, 0.0],
                    vec![-1.0, 1.0, 0.0, 0.0, -3.0, 5.0, 2.0, -2.0, 0.0, -3.0, -2.0, 1.0, 0.0, -3.0, -1.0, 0.0, -1.0, -2.0, -1.0, -2.0, 0.0],
                    vec![-1.0, 0.0, 0.0, 2.0, -4.0, 2.0, 5.0, -2.0, 0.0, -3.0, -3.0, 1.0, -2.0, -3.0, -1.0, 0.0, -1.0, -3.0, -2.0, -2.0, 0.0],
                    vec![0.0, -2.0, 0.0, -1.0, -3.0, -2.0, -2.0, 6.0, -2.0, -4.0, -4.0, -2.0, -3.0, -3.0, -2.0, 0.0, -2.0, -2.0, -3.0, -3.0, 0.0],
                    vec![-2.0, 0.0, 1.0, -1.0, -3.0, 0.0, 0.0, -2.0, 8.0, -3.0, -3.0, -1.0, -2.0, -1.0, -2.0, -1.0, -2.0, -2.0, 2.0, -3.0, 0.0],
                    vec![-1.0, -3.0, -3.0, -3.0, -1.0, -3.0, -3.0, -4.0, -3.0, 4.0, 2.0, -3.0, 1.0, 0.0, -3.0, -2.0, -1.0, -3.0, -1.0, 3.0, 0.0],
                    vec![-1.0, -2.0, -3.0, -4.0, -1.0, -2.0, -3.0, -4.0, -3.0, 2.0, 4.0, -2.0, 2.0, 0.0, -3.0, -2.0, -1.0, -2.0, -1.0, 1.0, 0.0],
                    vec![-1.0, 2.0, 0.0, -1.0, -3.0, 1.0, 1.0, -2.0, -1.0, -3.0, -2.0, 5.0, -1.0, -3.0, -1.0, 0.0, -1.0, -3.0, -2.0, -2.0, 0.0],
                    vec![-1.0, -1.0, -2.0, -3.0, -1.0, 0.0, -2.0, -3.0, -2.0, 1.0, 2.0, -1.0, 5.0, 0.0, -2.0, -1.0, -1.0, -1.0, -1.0, 1.0, 0.0],
                    vec![-2.0, -3.0, -3.0, -3.0, -2.0, -3.0, -3.0, -3.0, -1.0, 0.0, 0.0, -3.0, 0.0, 6.0, -4.0, -2.0, -2.0, 1.0, 3.0, -1.0, 0.0],
                    vec![-1.0, -2.0, -2.0, -1.0, -3.0, -1.0, -1.0, -2.0, -2.0, -3.0, -3.0, -1.0, -2.0, -4.0, 7.0, -1.0, -1.0, -4.0, -3.0, -2.0, 0.0],
                    vec![1.0, -1.0, 1.0, 0.0, -1.0, 0.0, 0.0, 0.0, -1.0, -2.0, -2.0, 0.0, -1.0, -2.0, -1.0, 4.0, 1.0, -3.0, -2.0, -2.0, 0.0],
                    vec![0.0, -1.0, 0.0, -1.0, -1.0, -1.0, -1.0, -2.0, -2.0, -1.0, -1.0, -1.0, -1.0, -2.0, -1.0, 1.0, 5.0, -2.0, -2.0, 0.0, 0.0],
                    vec![-3.0, -3.0, -4.0, -4.0, -2.0, -2.0, -3.0, -2.0, -2.0, -3.0, -2.0, -3.0, -1.0, 1.0, -4.0, -3.0, -2.0, 11.0, 2.0, -3.0, 0.0],
                    vec![-2.0, -2.0, -2.0, -3.0, -2.0, -1.0, -2.0, -3.0, 2.0, -1.0, -1.0, -2.0, -1.0, 3.0, -3.0, -2.0, -2.0, 2.0, 7.0, -1.0, 0.0],
                    vec![0.0, -3.0, -3.0, -3.0, -1.0, -2.0, -2.0, -3.0, -3.0, 3.0, 1.0, -2.0, 1.0, -1.0, -2.0, -2.0, 0.0, -3.0, -1.0, 4.0, 0.0],
                    vec![0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
                ]);

                SubstitutionMatrix{
                    names: names,
                    data: data,
                }
            },
            Matrix::PAM250 => {
                let names: Vec<char> = "ARNDCQEGHILKMFPSTWYV-".chars().collect();
                let data = Vec::from([
                    vec![2.0, -2.0, 0.0, 0.0, -2.0, 0.0, 0.0, 1.0, -1.0, -1.0, -2.0, -1.0, -1.0, -3.0, 1.0, 1.0, 1.0, -6.0, -3.0, 0.0, 0.0],
                    vec![-2.0, 6.0, 0.0, -1.0, -4.0, 1.0, -1.0, -3.0, 2.0, -2.0, -3.0, 3.0, 0.0, -4.0, 0.0, 0.0, -1.0, 2.0, -4.0, -2.0, 0.0],
                    vec![0.0, 0.0, 2.0, 2.0, -4.0, 1.0, 1.0, 0.0, 2.0, -2.0, -3.0, 1.0, -2.0, -3.0, 0.0, 1.0, 0.0, -4.0, -2.0, -2.0, 0.0],
                    vec![0.0, -1.0, 2.0, 4.0, -5.0, 2.0, 3.0, 1.0, 1.0, -2.0, -4.0, 0.0, -3.0, -6.0, -1.0, 0.0, 0.0, -7.0, -4.0, -2.0, 0.0],
                    vec![-2.0, -4.0, -4.0, -5.0, 12.0, -5.0, -5.0, -3.0, -3.0, -2.0, -6.0, -5.0, -5.0, -4.0, -3.0, 0.0, -2.0, -8.0, 0.0, -2.0, 0.0],
                    vec![0.0, 1.0, 1.0, 2.0, -5.0, 4.0, 2.0, -1.0, 3.0, -2.0, -2.0, 1.0, -1.0, -5.0, 0.0, -1.0, -1.0, -5.0, -4.0, -2.0, 0.0],
                    vec![0.0, -1.0, 1.0, 3.0, -5.0, 2.0, 4.0, 0.0, 1.0, -2.0, -3.0, 0.0, -2.0, -5.0, -1.0, 0.0, 0.0, -7.0, -4.0, -2.0, 0.0],
                    vec![1.0, -3.0, 0.0, 1.0, -3.0, -1.0, 0.0, 5.0, -2.0, -3.0, -4.0, -2.0, -3.0, -5.0, 0.0, 1.0, 0.0, -7.0, -5.0, -1.0, 0.0],
                    vec![-1.0, 2.0, 2.0, 1.0, -3.0, 3.0, 1.0, -2.0, 6.0, -2.0, -2.0, 0.0, -2.0, -2.0, 0.0, -1.0, -1.0, -3.0, 0.0, -2.0, 0.0],
                    vec![-1.0, -2.0, -2.0, -2.0, -2.0, -2.0, -2.0, -3.0, -2.0, 5.0, 2.0, -2.0, 2.0, 1.0, -2.0, -1.0, 0.0, -5.0, -1.0, 4.0, 0.0],
                    vec![-2.0, -3.0, -3.0, -4.0, -6.0, -2.0, -3.0, -4.0, -2.0, 2.0, 6.0, -3.0, 4.0, 2.0, -3.0, -3.0, -2.0, -2.0, -1.0, 2.0, 0.0],
                    vec![-1.0, 3.0, 1.0, 0.0, -5.0, 1.0, 0.0, -2.0, 0.0, -2.0, -3.0, 5.0, 0.0, -5.0, -1.0, 0.0, 0.0, -3.0, -4.0, -2.0, 0.0],
                    vec![-1.0, 0.0, -2.0, -3.0, -5.0, -1.0, -2.0, -3.0, -2.0, 2.0, 4.0, 0.0, 6.0, 0.0, -2.0, -2.0, -1.0, -4.0, -2.0, 2.0, 0.0],
                    vec![-3.0, -4.0, -3.0, -6.0, -4.0, -5.0, -5.0, -5.0, -2.0, 1.0, 2.0, -5.0, 0.0, 9.0, -5.0, -3.0, -3.0, 0.0, 7.0, -1.0, 0.0],
                    vec![1.0, 0.0, 0.0, -1.0, -3.0, 0.0, -1.0, 0.0, 0.0, -2.0, -3.0, -1.0, -2.0, -5.0, 6.0, 1.0, 0.0, -6.0, -5.0, -1.0, 0.0],
                    vec![1.0, 0.0, 1.0, 0.0, 0.0, -1.0, 0.0, 1.0, -1.0, -1.0, -3.0, 0.0, -2.0, -3.0, 1.0, 2.0, 1.0, -2.0, -3.0, -1.0, 0.0],
                    vec![1.0, -1.0, 0.0, 0.0, -2.0, -1.0, 0.0, 0.0, -1.0, 0.0, -2.0, 0.0, -1.0, -3.0, 0.0, 1.0, 3.0, -5.0, -3.0, 0.0, 0.0],
                    vec![-6.0, 2.0, -4.0, -7.0, -8.0, -5.0, -7.0, -7.0, -3.0, -5.0, -2.0, -3.0, -4.0, 0.0, -6.0, -2.0, -5.0, 17.0, 0.0, -6.0, 0.0],
                    vec![-3.0, -4.0, -2.0, -4.0, 0.0, -4.0, -4.0, -5.0, 0.0, -1.0, -1.0, -4.0, -2.0, 7.0, -5.0, -3.0, -3.0, 0.0, 10.0, -2.0, 0.0],
                    vec![0.0, -2.0, -2.0, -2.0, -2.0, -2.0, -2.0, -1.0, -2.0, 4.0, 2.0, -2.0, 2.0, -1.0, -1.0, -1.0, 0.0, -6.0, -2.0, 4.0, 0.0],
                    vec![0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
                ]);

                SubstitutionMatrix{
                    names: names,
                    data: data,
                }
            },
            Matrix::GONNET => {
                let names: Vec<char> = "CSTPAGNDEQHRKMILVFYW-".chars().collect();
                let data = Vec::from([
                    vec![12.0, 0.0, 0.0, -3.0, 0.0, -2.0, -2.0, -3.0, -3.0, -2.0, -1.0, -2.0, -3.0, -1.0, -1.0, -2.0, 0.0, -1.0, 0.0, -1.0, 0.0],
                    vec![0.0, 2.0, 2.0, 0.0, 1.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, -1.0, -2.0, -2.0, -1.0, -3.0, -2.0, -3.0, 0.0],
                    vec![0.0, 2.0, 2.0, 0.0, 1.0, -1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, -1.0, -1.0, -1.0, 0.0, -2.0, -2.0, -4.0, 0.0],
                    vec![-3.0, 0.0, 0.0, 8.0, 0.0, -2.0, -1.0, -1.0, 0.0, 0.0, -1.0, -1.0, -1.0, -2.0, -3.0, -2.0, -2.0, -4.0, -3.0, -5.0, 0.0],
                    vec![0.0, 1.0, 1.0, 0.0, 2.0, 0.0, 0.0, 0.0, 0.0, 0.0, -1.0, -1.0, 0.0, -1.0, -1.0, -1.0, 0.0, -2.0, -2.0, -4.0, 0.0],
                    vec![-2.0, 0.0, -1.0, -2.0, 0.0, 7.0, 0.0, 0.0, -1.0, -1.0, -1.0, -1.0, -1.0, -4.0, -4.0, -4.0, -3.0, -5.0, -4.0, -4.0, 0.0],
                    vec![-2.0, 1.0, 0.0, -1.0, 0.0, 0.0, 4.0, 2.0, 1.0, 1.0, 1.0, 0.0, 1.0, -2.0, -3.0, -3.0, -2.0, -3.0, -1.0, -4.0, 0.0],
                    vec![-3.0, 0.0, 0.0, -1.0, 0.0, 0.0, 2.0, 5.0, 3.0, 1.0, 0.0, 0.0, 0.0, -3.0, -4.0, -4.0, -3.0, -4.0, -3.0, -5.0, 0.0],
                    vec![-3.0, 0.0, 0.0, 0.0, 0.0, -1.0, 1.0, 3.0, 4.0, 2.0, 0.0, 0.0, 1.0, -2.0, -3.0, -3.0, -2.0, -4.0, -3.0, -4.0, 0.0],
                    vec![-2.0, 0.0, 0.0, 0.0, 0.0, -1.0, 1.0, 1.0, 2.0, 3.0, 1.0, 2.0, 2.0, -1.0, -2.0, -2.0, -2.0, -3.0, -2.0, -3.0, 0.0],
                    vec![-1.0, 0.0, 0.0, -1.0, -1.0, -1.0, 1.0, 0.0, 0.0, 1.0, 6.0, 1.0, 1.0, -1.0, -2.0, -2.0, -2.0, 0.0, 2.0, -1.0, 0.0],
                    vec![-2.0, 0.0, 0.0, -1.0, -1.0, -1.0, 0.0, 0.0, 0.0, 2.0, 1.0, 5.0, 3.0, -2.0, -2.0, -2.0, -2.0, -3.0, -2.0, -2.0, 0.0],
                    vec![-3.0, 0.0, 0.0, -1.0, 0.0, -1.0, 1.0, 0.0, 1.0, 2.0, 1.0, 3.0, 3.0, -1.0, -2.0, -2.0, -2.0, -3.0, -2.0, -4.0, 0.0],
                    vec![-1.0, -1.0, -1.0, -2.0, -1.0, -4.0, -2.0, -3.0, -2.0, -1.0, -1.0, -2.0, -1.0, 4.0, 2.0, 3.0, 2.0, 2.0, 0.0, -1.0, 0.0],
                    vec![-1.0, -2.0, -1.0, -3.0, -1.0, -4.0, -3.0, -4.0, -3.0, -2.0, -2.0, -2.0, -2.0, 2.0, 4.0, 3.0, 3.0, 1.0, -1.0, -2.0, 0.0],
                    vec![-2.0, -2.0, -1.0, -2.0, -1.0, -4.0, -3.0, -4.0, -3.0, -2.0, -2.0, -2.0, -2.0, 3.0, 3.0, 4.0, 2.0, 2.0, 0.0, -1.0, 0.0],
                    vec![0.0, -1.0, 0.0, -2.0, 0.0, -3.0, -2.0, -3.0, -2.0, -2.0, -2.0, -2.0, -2.0, 2.0, 3.0, 2.0, 3.0, 0.0, -1.0, -3.0, 0.0],
                    vec![-1.0, -3.0, -2.0, -4.0, -2.0, -5.0, -3.0, -4.0, -4.0, -3.0, 0.0, -3.0, -3.0, 2.0, 1.0, 2.0, 0.0, 7.0, 5.0, 4.0, 0.0],
                    vec![0.0, -2.0, -2.0, -3.0, -2.0, -4.0, -1.0, -3.0, -3.0, -2.0, 2.0, -2.0, -2.0, 0.0, -1.0, 0.0, -1.0, 5.0, 8.0, 4.0, 0.0],
                    vec![-1.0, -3.0, -4.0, -5.0, -4.0, -4.0, -4.0, -5.0, -4.0, -3.0, -1.0, -2.0, -4.0, -1.0, -2.0, -1.0, -3.0, 4.0, 4.0, 14.0, 0.0],
                    vec![0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
                ]);

                SubstitutionMatrix{
                    names: names,
                    data: data,
                }

            },
        }

    }

    /// Return the value r,c of the matrix, if index in range
    /// If not return None
    fn get_by_index(&self, r: usize, c: usize) -> Option<f64> {
        if r < self.names.len() && c < self.names.len() {
            Some(self.data[r][c])

        } else {
            None
        }
    }

    fn char_index(&self, aa: char) -> Option<usize> {
        for i in 0..self.names.len() {
            if aa == self.names[i] {
                return Some(i);
            }
        }

        None
    }

    /// Retrieve the values in the matrix converting the amino
    /// acid names into appropriated indices.
    fn get_by_char(&self, aar: char, aac:char) -> Option<f64> {        

        let r = match self.char_index(aar) {
            Some(x) => x,
            None => return None
        };

        let c = match self.char_index(aac) {
            Some(x) => x,
            None => return None
        };

        self.get_by_index(r, c)
    }

    /// Use get_by_char to retrieve matrix values.
    pub fn get(&self, aar: char, aac:char) -> Option<f64> {
        self.get_by_char(aar, aac)
    }
}