scattr 0.2.1

A tool for estimating the copy number of large tandem repeats
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
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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
use std::{collections::HashMap, hash::Hash};

use bio::{alignment::distance::simd::hamming, alphabets::dna::revcomp};
use serde::de::{self, Visitor};
use serde::{Deserialize, Deserializer, Serialize, Serializer};
use std::fmt;
use std::str::FromStr;

use crate::genotype::TandemRepeatGenotype;

const ORIENTATIONS: [Orientation; 2] = [Orientation::Forward, Orientation::Reverse];

pub type Base = u8;
pub type Position = i64;
pub type HammingDistance = u64;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Haplotype {
    Haplotype1,
    Haplotype2,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Orientation {
    Forward,
    Reverse,
}

impl Orientation {
    pub fn opposite(&self) -> Orientation {
        match self {
            Orientation::Forward => Orientation::Reverse,
            Orientation::Reverse => Orientation::Forward,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum AlignmentPosition {
    Mapped(Haplotype, Orientation, Position),
    Unmapped,
}

impl AlignmentPosition {
    pub fn is_mapped(&self) -> bool {
        match self {
            AlignmentPosition::Mapped(_, _, _) => true,
            AlignmentPosition::Unmapped => false,
        }
    }

    pub fn haplotype(&self) -> Option<Haplotype> {
        match self {
            AlignmentPosition::Mapped(haplotype, _, _) => Some(*haplotype),
            AlignmentPosition::Unmapped => None,
        }
    }

    pub fn orientation(&self) -> Option<Orientation> {
        match self {
            AlignmentPosition::Mapped(_, orientation, _) => Some(*orientation),
            AlignmentPosition::Unmapped => None,
        }
    }

    pub fn pos(&self) -> Option<Position> {
        match self {
            AlignmentPosition::Mapped(_, _, position) => Some(*position),
            AlignmentPosition::Unmapped => None,
        }
    }

    pub fn is_valid_mate_position(&self, mate: &AlignmentPosition) -> bool {
        match (self, mate) {
            (AlignmentPosition::Mapped(h1, o1, _), AlignmentPosition::Mapped(h2, o2, _)) => {
                h1 == h2 && o1.opposite() == *o2
            }
            _ => false,
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub enum RepeatAlignmentPosition {
    RelativeToRepeatStart(Orientation, Position),
    RelativeToRepeatEnd(Orientation, Position),
    WithinRepeat(Orientation, Position),
    Absolute(Orientation, Position),
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct RepeatAlignmentPositionSetGenerator {
    query: Vec<Base>,
    left_flank: Vec<Base>,
    right_flank: Vec<Base>,
    repeat_unit: Vec<Base>,
    relative_pos: Vec<(RepeatAlignmentPosition, HammingDistance)>,
    num_lowest_edit_scores: usize,
}

impl RepeatAlignmentPositionSetGenerator {
    pub fn new(
        query: &[Base],
        repeat_unit: &[Base],
        left_flank_seq: &[Base],
        right_flank_seq: &[Base],
        num_lowest_edit_scores: usize,
    ) -> Self {
        let relative_pos = Self::get_relative_pos(
            left_flank_seq,
            right_flank_seq,
            repeat_unit,
            query,
            num_lowest_edit_scores,
        );

        Self {
            left_flank: left_flank_seq.to_vec(),
            right_flank: right_flank_seq.to_vec(),
            repeat_unit: repeat_unit.to_vec(),
            relative_pos,
            query: query.to_vec(),
            num_lowest_edit_scores,
        }
    }

    pub fn from_precomputed(
        query: &[Base],
        repeat_unit: &[Base],
        left_flank_seq: &[Base],
        right_flank_seq: &[Base],
        num_lowest_edit_scores: usize,
        relative_pos: Vec<(RepeatAlignmentPosition, HammingDistance)>,
    ) -> Self {
        Self {
            left_flank: left_flank_seq.to_vec(),
            right_flank: right_flank_seq.to_vec(),
            repeat_unit: repeat_unit.to_vec(),
            relative_pos,
            query: query.to_vec(),
            num_lowest_edit_scores,
        }
    }

    pub fn relative_position_set(&self) -> Vec<(RepeatAlignmentPosition, HammingDistance)> {
        self.relative_pos.clone()
    }

    pub fn generate_position_set(
        &self,
        genotype: TandemRepeatGenotype,
        left_flank_len: usize,
        right_flank_len: usize,
    ) -> Vec<(AlignmentPosition, HammingDistance)> {
        let (hap1_genotype, hap2_genotype) = genotype.into();
        let (hap1_repeat_start, hap2_repeat_start) =
            (left_flank_len as Position, left_flank_len as Position);
        let (hap1_repeat_end, hap2_repeat_end) = (
            hap1_repeat_start + (hap1_genotype as Position * self.repeat_unit.len() as Position),
            hap2_repeat_start + (hap2_genotype as Position * self.repeat_unit.len() as Position),
        );
        let (hap1_len, hap2_len) = (
            hap1_repeat_end + right_flank_len as Position,
            hap1_repeat_end + right_flank_len as Position,
        );

        let hap1_abs_positions = self.generate_absolute_position_set(
            hap1_repeat_start,
            hap1_repeat_end,
            left_flank_len,
            right_flank_len,
        );
        let hap2_abs_positions = self.generate_absolute_position_set(
            hap2_repeat_start,
            hap2_repeat_end,
            left_flank_len,
            right_flank_len,
        );

        let hap1_positions = Self::convert_absolute(hap1_abs_positions, Haplotype::Haplotype1);
        let hap2_positions = Self::convert_absolute(hap2_abs_positions, Haplotype::Haplotype2);

        let merged_iter = hap1_positions.into_iter().chain(hap2_positions);

        // If any absolute positions are outside the haplotype length, remove them

        merged_iter
            .filter(|(pos, _)| match pos {
                AlignmentPosition::Mapped(Haplotype::Haplotype1, _, pos) => {
                    *pos >= 0 && *pos < (hap1_len - self.query.len() as Position + 1)
                }
                AlignmentPosition::Mapped(Haplotype::Haplotype2, _, pos) => {
                    *pos >= 0 && *pos < (hap2_len - self.query.len() as Position + 1)
                }
                _ => unreachable!(),
            })
            .collect()
    }

    pub fn distance_furthest_from_repeat_start(&self) -> u32 {
        let mut max_dist = 0;
        for (pos, _) in &self.relative_pos {
            if let RepeatAlignmentPosition::RelativeToRepeatStart(_, dist) = pos {
                max_dist = max_dist.max((*dist).unsigned_abs() as u32);
            }
        }
        max_dist
    }

    pub fn distance_furthest_from_repeat_end(&self) -> u32 {
        let mut max_dist = 0;
        for (pos, _) in &self.relative_pos {
            if let RepeatAlignmentPosition::RelativeToRepeatEnd(_, dist) = pos {
                let query_end = dist + self.query.len() as Position;
                max_dist = max_dist.max((query_end).unsigned_abs() as u32);
            }
        }
        max_dist
    }

    fn convert_absolute(
        positions: Vec<(RepeatAlignmentPosition, HammingDistance)>,
        haplotype: Haplotype,
    ) -> Vec<(AlignmentPosition, HammingDistance)> {
        positions
            .into_iter()
            .map(|(pos, d)| match pos {
                RepeatAlignmentPosition::Absolute(orientation, pos) => {
                    (AlignmentPosition::Mapped(haplotype, orientation, pos), d)
                }
                _ => unreachable!(),
            })
            .collect()
    }

    fn generate_absolute_position_set(
        &self,
        repeat_start: Position,
        repeat_end: Position,
        left_flank_len: usize,
        right_flank_len: usize,
    ) -> Vec<(RepeatAlignmentPosition, HammingDistance)> {
        if ((repeat_end - repeat_start) as usize) < self.query.len() {
            self.generate_absolute_position_set_short(
                repeat_start,
                repeat_end,
                left_flank_len,
                right_flank_len,
            )
        } else {
            self.generate_absolute_position_set_long(repeat_start, repeat_end)
        }
    }

    fn generate_absolute_position_set_short(
        &self,
        repeat_start: Position,
        repeat_end: Position,
        left_flank_len: usize,
        right_flank_len: usize,
    ) -> Vec<(RepeatAlignmentPosition, HammingDistance)> {
        assert!((repeat_end - repeat_start) % self.repeat_unit.len() as i64 == 0);
        let num_repeats = (repeat_end - repeat_start) as usize / self.repeat_unit.len();
        let trimmed_left_flank =
            &self.left_flank[self.left_flank.len() - left_flank_len..self.left_flank.len()];
        let trimmed_right_flank = &self.right_flank[0..right_flank_len];
        let reference = Self::full_reference(
            trimmed_left_flank,
            trimmed_right_flank,
            &self.repeat_unit,
            num_repeats,
        );
        let dists = Self::sliding_hamming(&reference, &self.query);

        Self::filter_by_num_lowest_edit_scores(dists, self.num_lowest_edit_scores)
    }

    fn generate_absolute_position_set_long(
        &self,
        repeat_start: Position,
        repeat_end: Position,
    ) -> Vec<(RepeatAlignmentPosition, HammingDistance)> {
        assert!((repeat_end - repeat_start) % self.repeat_unit.len() as i64 == 0);
        let num_repeats = (repeat_end - repeat_start) as usize / self.repeat_unit.len();
        self.relative_pos
            .iter()
            .flat_map(|(aln_pos, d)| match aln_pos {
                RepeatAlignmentPosition::RelativeToRepeatStart(orientation, pos) => {
                    vec![(
                        RepeatAlignmentPosition::Absolute(*orientation, pos + repeat_start),
                        *d,
                    )]
                }
                RepeatAlignmentPosition::RelativeToRepeatEnd(orientation, pos) => {
                    vec![(
                        RepeatAlignmentPosition::Absolute(*orientation, pos + repeat_end),
                        *d,
                    )]
                }
                RepeatAlignmentPosition::WithinRepeat(orient, pos) => {
                    let abs_pos = self.within_repeat_absolute_positions(
                        *pos,
                        *orient,
                        repeat_start,
                        repeat_end,
                        num_repeats,
                    );
                    abs_pos.into_iter().map(|p| (p, *d)).collect()
                }
                RepeatAlignmentPosition::Absolute(_, _) => unreachable!(),
            })
            .collect()
    }

    fn within_repeat_absolute_positions(
        &self,
        pos: Position,
        orient: Orientation,
        repeat_start: Position,
        repeat_end: Position,
        num_repeats: usize,
    ) -> Vec<RepeatAlignmentPosition> {
        (0..num_repeats)
            .filter_map(|i| {
                let shift = repeat_start + (i * self.repeat_unit.len()) as Position;
                let pos = pos + shift;
                if pos + self.query.len() as Position <= repeat_end {
                    Some(RepeatAlignmentPosition::Absolute(orient, pos))
                } else {
                    None
                }
            })
            .collect()
    }

    fn full_reference(
        left_flank_seq: &[Base],
        right_flank_seq: &[Base],
        repeat_unit: &[Base],
        num_repeats: usize,
    ) -> Vec<Base> {
        left_flank_seq
            .iter()
            .chain(
                repeat_unit
                    .iter()
                    .cycle()
                    .take(repeat_unit.len() * num_repeats),
            )
            .chain(right_flank_seq.iter())
            .copied()
            .collect()
    }

    fn sliding_hamming(
        reference: &[Base],
        query: &[Base],
    ) -> HashMap<HammingDistance, Vec<RepeatAlignmentPosition>> {
        let query_orientations = Self::get_query_orientations(query);
        let mut dists = HashMap::new();
        for (orientation, query) in query_orientations {
            for i in 0..(reference.len() - query.len() + 1) {
                let ref_slice = &reference[i..i + query.len()];
                let d = hamming(ref_slice, &query);
                dists
                    .entry(d)
                    .or_insert(vec![])
                    .push(RepeatAlignmentPosition::Absolute(
                        orientation,
                        i as Position,
                    ));
            }
        }
        dists
    }

    fn filter_by_num_lowest_edit_scores(
        dists: HashMap<HammingDistance, Vec<RepeatAlignmentPosition>>,
        num_lowest_edit_scores: usize,
    ) -> Vec<(RepeatAlignmentPosition, HammingDistance)> {
        // Find the lowest edit scores
        let mut distances: Vec<HammingDistance> = dists.keys().cloned().collect();
        distances.sort();
        distances.truncate(num_lowest_edit_scores);

        // Filter the positions and return a vector
        let mut filtered = vec![];
        for d in distances {
            filtered.extend(dists.get(&d).unwrap().iter().map(|pos| (*pos, d)));
        }
        filtered
    }

    fn left_flank_reference(
        left_flank_seq: &[Base],
        repeat_unit: &[Base],
        pad: usize,
    ) -> Vec<Base> {
        left_flank_seq
            .iter()
            .chain(repeat_unit.iter().cycle().take(pad))
            .copied()
            .collect()
    }

    fn right_flank_reference(
        right_flank_seq: &[Base],
        repeat_unit: &[Base],
        pad: usize,
    ) -> Vec<Base> {
        let reversed: Vec<Base> = right_flank_seq
            .iter()
            .rev()
            .chain(repeat_unit.iter().rev().cycle().take(pad))
            .cloned()
            .collect();
        reversed.iter().rev().copied().collect()
    }

    fn in_repeat_reference(repeat_unit: &[Base], len: usize) -> Vec<Base> {
        repeat_unit.iter().cycle().take(len).copied().collect()
    }

    fn get_query_orientations(query: &[Base]) -> Vec<(Orientation, Vec<Base>)> {
        ORIENTATIONS
            .iter()
            .map(|orientation| match orientation {
                Orientation::Forward => (*orientation, query.to_vec()),
                Orientation::Reverse => (*orientation, revcomp(query)),
            })
            .collect()
    }

    fn get_relative_pos(
        left_flank_seq: &[Base],
        right_flank_seq: &[Base],
        repeat_unit: &[Base],
        query: &[Base],
        num_lowest_edit_scores: usize,
    ) -> Vec<(RepeatAlignmentPosition, HammingDistance)> {
        // Create references to calculate hamming distances against
        let left_reference =
            Self::left_flank_reference(left_flank_seq, repeat_unit, query.len() - 1);
        let right_reference =
            Self::right_flank_reference(right_flank_seq, repeat_unit, query.len() - 1);
        let in_repeat_reference =
            Self::in_repeat_reference(repeat_unit, query.len() + repeat_unit.len() - 1);

        // Calculate sliding hamming distances between references and query
        let left_flank_pos =
            Self::sliding_hamming_left_flank(&left_reference, query, left_flank_seq.len());
        let right_flank_pos =
            Self::sliding_hamming_right_flank(&right_reference, query, query.len() - 1);
        let in_repeat_pos =
            Self::sliding_hamming_in_repeat(&in_repeat_reference, query, repeat_unit.len());

        // Merge into a single hashmap
        let chained_iter = left_flank_pos
            .into_iter()
            .chain(right_flank_pos)
            .chain(in_repeat_pos);
        let mut merged = HashMap::new();
        for (d, pos) in chained_iter {
            merged.entry(d).or_insert(vec![]).extend(pos);
        }

        // Filter by the lowest edit scores
        Self::filter_by_num_lowest_edit_scores(merged, num_lowest_edit_scores)
    }

    fn sliding_hamming_left_flank(
        reference: &[Base],
        query: &[Base],
        repeat_start: usize,
    ) -> HashMap<HammingDistance, Vec<RepeatAlignmentPosition>> {
        let query_orientations = Self::get_query_orientations(query);
        let mut dists = HashMap::new();
        for (orientation, target_query) in query_orientations {
            for i in 0..repeat_start {
                let ref_slice = &reference[i..i + target_query.len()];
                let d = hamming(ref_slice, &target_query);
                let relative_pos = i as i64 - repeat_start as i64;
                dists.entry(d).or_insert(vec![]).push(
                    RepeatAlignmentPosition::RelativeToRepeatStart(orientation, relative_pos),
                );
                // let my_query = b"ACGCCGTGAAATGTCCTTGTCCTACAATGGCAAATTGGTATCTAATGGATGGAGGCTATTGACCTGAGTCAGTTTTTGGAGGCCCCGGACTATGACCAATCCTTCAAACACAATTGCGGGATATCTGTATCTGTATCTGTATCTGTATCT";
                // if query == my_query {
                //     println!(
                //         "Relative positions: {:?}, d: {}",
                //         RepeatAlignmentPosition::RelativeToRepeatStart(orientation, relative_pos),
                //         d
                //     );
                // }
            }
        }
        dists
    }

    fn sliding_hamming_right_flank(
        reference: &[Base],
        query: &[Base],
        repeat_end: usize,
    ) -> HashMap<HammingDistance, Vec<RepeatAlignmentPosition>> {
        let query_orientations = Self::get_query_orientations(query);
        let mut dists = HashMap::new();
        for (orientation, target_query) in query_orientations {
            // First position in the right flank where the query can start
            // (where the query overalps with the repeat by 1 base)
            let range_start = repeat_end + 1 - target_query.len();
            assert!(range_start == 0);
            let range_end = reference.len() + 1 - target_query.len();
            for i in range_start..range_end {
                let ref_slice = &reference[i..i + target_query.len()];
                let d = hamming(ref_slice, &target_query);
                let rel_pos = (i as i64) - (repeat_end as i64);
                dists.entry(d).or_insert(vec![]).push(
                    RepeatAlignmentPosition::RelativeToRepeatEnd(orientation, rel_pos),
                );
            }
        }
        dists
    }

    fn sliding_hamming_in_repeat(
        reference: &[Base],
        query: &[Base],
        repeat_unit_len: usize,
    ) -> HashMap<HammingDistance, Vec<RepeatAlignmentPosition>> {
        let query_orientations = Self::get_query_orientations(query);
        let mut dists = HashMap::new();
        for (orientation, query) in query_orientations {
            for i in 0..repeat_unit_len {
                let ref_slice = &reference[i..i + query.len()];
                let d = hamming(ref_slice, &query);
                dists
                    .entry(d)
                    .or_insert(vec![])
                    .push(RepeatAlignmentPosition::WithinRepeat(
                        orientation,
                        i as Position,
                    ));
            }
        }
        dists
    }
}

impl Serialize for RepeatAlignmentPosition {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        let s = match self {
            RepeatAlignmentPosition::RelativeToRepeatStart(orientation, position) => {
                format!("RelativeToRepeatStart({:?}, {:?})", orientation, position)
            }
            RepeatAlignmentPosition::RelativeToRepeatEnd(orientation, position) => {
                format!("RelativeToRepeatEnd({:?}, {:?})", orientation, position)
            }
            RepeatAlignmentPosition::WithinRepeat(orientation, position) => {
                format!("WithinRepeat({:?}, {:?})", orientation, position)
            }
            RepeatAlignmentPosition::Absolute(orientation, position) => {
                format!("Absolute({:?}, {:?})", orientation, position)
            }
        };
        serializer.serialize_str(&s)
    }
}

impl<'de> Deserialize<'de> for RepeatAlignmentPosition {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: Deserializer<'de>,
    {
        struct RepeatAlignmentPositionVisitor;

        impl<'de> Visitor<'de> for RepeatAlignmentPositionVisitor {
            type Value = RepeatAlignmentPosition;

            fn expecting(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
                formatter.write_str("a string representing a RepeatAlignmentPosition enum variant")
            }

            fn visit_str<E>(self, v: &str) -> Result<Self::Value, E>
            where
                E: de::Error,
            {
                // Parse the input string and extract enum variant, orientation and position
                let mut parts = v.splitn(2, '(');
                let variant = parts.next().unwrap();
                let args = parts.next().ok_or_else(|| E::custom("invalid format"))?;
                let args = args.trim_end_matches(')').replace(' ', "");
                let mut args_iter = args.split(',');

                let orientation_str = args_iter
                    .next()
                    .ok_or_else(|| E::custom("missing orientation"))?;
                let position_str = args_iter
                    .next()
                    .ok_or_else(|| E::custom("missing position"))?;

                let orientation = match orientation_str {
                    "Forward" => Orientation::Forward,
                    "Reverse" => Orientation::Reverse,
                    _ => return Err(E::custom("invalid orientation")),
                };

                let position: i64 = i64::from_str(position_str).map_err(E::custom)?;

                match variant {
                    "RelativeToRepeatStart" => Ok(RepeatAlignmentPosition::RelativeToRepeatStart(
                        orientation,
                        position,
                    )),
                    "RelativeToRepeatEnd" => Ok(RepeatAlignmentPosition::RelativeToRepeatEnd(
                        orientation,
                        position,
                    )),
                    "WithinRepeat" => {
                        Ok(RepeatAlignmentPosition::WithinRepeat(orientation, position))
                    }
                    "Absolute" => Ok(RepeatAlignmentPosition::Absolute(orientation, position)),
                    _ => Err(E::custom("invalid variant")),
                }
            }
        }

        deserializer.deserialize_str(RepeatAlignmentPositionVisitor)
    }
}