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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
extern crate log;
extern crate env_logger;
extern crate csv;

use std;
use std::collections::BTreeMap;
use log::*;

pub struct CheckMTabTable {
}

impl CheckMTabTable {
    pub fn good_quality_genome_names(file_path: &str, min_completeness: f32, max_contamination: f32) -> Vec<String> {
        let mut passes = vec![];
        let qualities = CheckMTabTable::read_file_path(file_path);
        for (genome, quality) in qualities.genome_to_quality.iter() {
            trace!("Genome: {}, Quality: {:?}", genome, quality);
            if quality.completeness >= min_completeness && quality.contamination <= max_contamination {
                passes.push(genome.clone())
            }
        }
        debug!("Read in {} genomes from {}, {} passed the quality thresholds", 
            qualities.genome_to_quality.len(), file_path, passes.len());
        return passes;
    }

    pub fn read_file_path(file_path: &str) -> CheckMResult {
        let mut qualities = BTreeMap::new();
        let rdr = csv::ReaderBuilder::new()
            .delimiter(b'\t')
            .has_headers(true)
            .from_path(std::path::Path::new(file_path));
        let mut total_seen = 0usize;

        for result in rdr
            .expect(&format!("Failed to parse CheckM tab table {}", file_path))
            .records() {

            let res = result.expect("Parsing error in CheckM tab table file");
            if res.len() != 14 {
                error!("Parsing error in CheckM tab table file - didn't find 13 columns in line {:?}", res);
                std::process::exit(1);
            }
            let completeness: f32 = res[11].parse::<f32>().expect("Error parsing completeness in checkm tab table");
            let contamination: f32 = res[12].parse::<f32>().expect("Error parsing contamination in checkm tab table");
            trace!("For {}, found completeness {} and contamination {}", &res[0], completeness, contamination);
            match qualities.insert(
                res[0].to_string(),
                GenomeQuality { 
                    completeness: completeness/100.,
                    contamination: contamination/100.,
                }) {
                None => {},
                Some(_) => {
                    error!("The genome {} was found multiple times in the checkm file {}", res[0].to_string(), file_path);
                    std::process::exit(1);
                }
            };
            total_seen += 1;
        }
        debug!("Read in {} genomes from {}", total_seen, file_path);
        return CheckMResult {
            genome_to_quality: qualities
        };
    }
}

pub struct CheckMResult {
    pub genome_to_quality: BTreeMap<String,GenomeQuality>,
}

impl CheckMResult {
    pub fn order_genomes_by_completeness_minus_4contamination(&self) -> Vec<&String> {
        let mut genomes_and_qualities: Vec<_> = self.genome_to_quality.iter().map(|(genome,quality)| (genome,quality)).collect();

        // sort in reverse order
        genomes_and_qualities.sort_unstable_by(|(_,q1),(_,q2)| 
            (q2.completeness - 4.*q2.contamination).partial_cmp(
                &(q1.completeness - 4.*q1.contamination)).unwrap());
        return genomes_and_qualities.into_iter().map(|(genome,_)| genome).collect();
    }

    pub fn order_genomes_by_completeness_minus_5contamination(&self) -> Vec<&String> {
        let mut genomes_and_qualities: Vec<_> = self.genome_to_quality.iter().map(|(genome,quality)| (genome,quality)).collect();

        // sort in reverse order
        genomes_and_qualities.sort_unstable_by(|(_,q1),(_,q2)| 
            (q2.completeness - 5.*q2.contamination).partial_cmp(
                &(q1.completeness - 5.*q1.contamination)).unwrap());
        return genomes_and_qualities.into_iter().map(|(genome,_)| genome).collect();
    }

    /// Map paths to FASTA paths to CheckM qualities, and return paths ordered
    /// by their quality, where quality is completeness - 4*contamination. If
    /// not None, min_completeness and max_contamination specify thresholds as
    /// fractions e.g. 0.8 not 80.
    pub fn order_fasta_paths_by_completeness_minus_4contamination<'a>(
        &self,
        genome_fasta_files: &Vec<&'a str>,
        min_completeness: Option<f32>,
        max_contamination: Option<f32>
    ) -> Result<Vec<&'a str>,String> {

        let mut key_to_order = BTreeMap::new();
        for (i,key) in self.order_genomes_by_completeness_minus_4contamination().into_iter().enumerate() {
            key_to_order.insert(key.as_str(), i);
        }
        self.order_fasta_list(&key_to_order, genome_fasta_files, min_completeness, max_contamination)
    }

    /// Map paths to FASTA paths to CheckM qualities, and return paths ordered
    /// by their quality, where quality is completeness - 5*contamination. If
    /// not None, min_completeness and max_contamination specify thresholds as
    /// fractions e.g. 0.8 not 80.
    pub fn order_fasta_paths_by_completeness_minus_5contamination<'a>(
        &self,
        genome_fasta_files: &Vec<&'a str>,
        min_completeness: Option<f32>,
        max_contamination: Option<f32>
    ) -> Result<Vec<&'a str>,String> {

        let mut key_to_order = BTreeMap::new();
        for (i,key) in self.order_genomes_by_completeness_minus_5contamination().into_iter().enumerate() {
            key_to_order.insert(key.as_str(), i);
        }
        self.order_fasta_list(&key_to_order, genome_fasta_files, min_completeness, max_contamination)
    }

    fn order_fasta_list<'a>(
        &self,
        key_to_order: &BTreeMap<&str,usize>,
        genome_fasta_files: &Vec<&'a str>,
        min_completeness: Option<f32>,
        max_contamination: Option<f32>)
        -> Result<Vec<&'a str>,String> {

        let mut fasta_and_order: Vec<(&str,usize)> = vec![];
        for fasta_path in genome_fasta_files.into_iter() {
            let checkm_name = std::path::Path::new(fasta_path).file_stem().unwrap().to_str().unwrap();
            match key_to_order.get(checkm_name) {
                Some(rank) => {
                    if (min_completeness.is_none() || 
                        self.genome_to_quality[checkm_name].completeness >= min_completeness.unwrap()) &&
                        (max_contamination.is_none() || 
                        self.genome_to_quality[checkm_name].contamination <= max_contamination.unwrap()) {

                        fasta_and_order.push((*fasta_path,*rank))
                    }
                },
                None => {
                    return Err(format!("Unable to find quality for genome fasta file {}",fasta_path));
                }
            }
        };
        fasta_and_order.sort_unstable_by(|a,b| a.1.cmp(&b.1));
        return Ok(fasta_and_order.into_iter().map(|(g,_)| g).collect())
    }

    pub fn filter(&self, min_completeness:f32, max_contamination:f32) -> CheckMResult {
        let mut new = BTreeMap::new();

        for (g,q) in self.genome_to_quality.iter() {
            if q.completeness >= min_completeness && q.contamination <= max_contamination {
                new.insert(g.clone().to_string(),*q);
            }
        }
        return CheckMResult {
            genome_to_quality: new
        }
    }
}

#[derive(Debug,PartialEq,Clone,Copy)]
pub struct GenomeQuality {
    pub completeness: f32,
    pub contamination: f32,
}

impl CheckMResult {
    pub fn retrieve_via_fasta_path(&self, fasta_path: &str) -> Result<GenomeQuality,()> {
        let checkm_name = std::path::Path::new(fasta_path).file_stem().unwrap().to_str().unwrap();
        match self.genome_to_quality.get(checkm_name) {
            Some(q) => Ok(*q),
            None => Err(())
        }
    }
}

#[cfg(test)]
mod test {
    use super::*;

    fn init() {
        let _ = env_logger::builder().is_test(true).try_init();
    }
    
    #[test]
    fn test_good_quality_genome_names() {
        init();
        assert_eq!(
            vec!["GUT_GENOME006390.gff","GUT_GENOME011264.gff","GUT_GENOME011296.gff","GUT_GENOME011536.gff"], 
            CheckMTabTable::good_quality_genome_names(&"tests/data/checkm.tsv",0.56,0.1))
    }

    #[test]
    fn test_retrieve() {
        init();
        let checkm = CheckMTabTable::read_file_path(&"tests/data/checkm.tsv");
        assert_eq!(
            Ok(GenomeQuality {
                completeness: 83.38/100.,
                contamination: 0.,
            }),
            checkm.retrieve_via_fasta_path(&"/some/path/GUT_GENOME011264.gff.fna"));
        assert_eq!(
            Err(()),
            checkm.retrieve_via_fasta_path(&"/some/path/GUT_not_a_genome_GENOME011264.gff.fna"));
    }

    #[test]
    fn test_ordering_4times() {
        init();
        let checkm = CheckMTabTable::read_file_path(&"tests/data/checkm.tsv");
        assert_eq!(
            vec!["GUT_GENOME006390.gff","GUT_GENOME011264.gff","GUT_GENOME011296.gff","GUT_GENOME011367.gff","GUT_GENOME011536.gff"],
            checkm.order_genomes_by_completeness_minus_4contamination());
        let checkm = CheckMTabTable::read_file_path(&"tests/data/checkm2.tsv");
        assert_eq!(
            vec!["GUT_GENOME006390.gff","GUT_GENOME011264.gff","GUT_GENOME011296.gff","GUT_GENOME011536.gff","GUT_GENOME011367.gff"],
            checkm.order_genomes_by_completeness_minus_4contamination());
    }

    #[test]
    fn test_ordering_5times() {
        init();
        // Cheating here a bit - same result as the minus_4times
        let checkm = CheckMTabTable::read_file_path(&"tests/data/checkm.tsv");
        assert_eq!(
            vec!["GUT_GENOME006390.gff","GUT_GENOME011264.gff","GUT_GENOME011296.gff","GUT_GENOME011367.gff","GUT_GENOME011536.gff"],
            checkm.order_genomes_by_completeness_minus_5contamination());
        let checkm = CheckMTabTable::read_file_path(&"tests/data/checkm2.tsv");
        assert_eq!(
            vec!["GUT_GENOME006390.gff","GUT_GENOME011264.gff","GUT_GENOME011296.gff","GUT_GENOME011536.gff","GUT_GENOME011367.gff"],
            checkm.order_genomes_by_completeness_minus_5contamination());
    }

    #[test]
    fn test_fasta_ordering_4times() {
        init();
        let checkm = CheckMTabTable::read_file_path(&"tests/data/checkm.tsv");
        assert_eq!(
            vec!["/tmp/GUT_GENOME006390.gff.fna","GUT_GENOME011264.gff.fna","GUT_GENOME011296.gff.fna","GUT_GENOME011367.gff.fna","GUT_GENOME011536.gff.fna"],
            checkm.order_fasta_paths_by_completeness_minus_4contamination(
                &vec!["GUT_GENOME011264.gff.fna","/tmp/GUT_GENOME006390.gff.fna","GUT_GENOME011296.gff.fna","GUT_GENOME011367.gff.fna","GUT_GENOME011536.gff.fna"],
                None,
                None,
            ).unwrap());
        let checkm = CheckMTabTable::read_file_path(&"tests/data/checkm2.tsv");
        assert_eq!(
            vec!["/tmp/GUT_GENOME006390.gff.fna","GUT_GENOME011264.gff.fna","GUT_GENOME011296.gff.fna","GUT_GENOME011536.gff.fna","GUT_GENOME011367.gff.fna"],
            checkm.order_fasta_paths_by_completeness_minus_4contamination(
                &vec!["GUT_GENOME011264.gff.fna","/tmp/GUT_GENOME006390.gff.fna","GUT_GENOME011296.gff.fna","GUT_GENOME011367.gff.fna","GUT_GENOME011536.gff.fna"],
                None,
                None,
            ).unwrap());
    }


    #[test]
    fn test_fasta_ordering_4times_min_completeness() {
        init();
        let checkm = CheckMTabTable::read_file_path(&"tests/data/checkm.tsv");
        assert_eq!(
            vec!["/tmp/GUT_GENOME006390.gff.fna","GUT_GENOME011264.gff.fna","GUT_GENOME011296.gff.fna"],
            checkm.order_fasta_paths_by_completeness_minus_4contamination(
                &vec!["GUT_GENOME011264.gff.fna","/tmp/GUT_GENOME006390.gff.fna","GUT_GENOME011296.gff.fna","GUT_GENOME011367.gff.fna","GUT_GENOME011536.gff.fna"],
                Some(0.7),
                None,
            ).unwrap());
    }
}