lib_tsshow 2.1.2

A visualiser for template-switch alignments
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
use std::{
    fmt::Debug,
    ops::{Bound, Range, RangeBounds},
};

use character::Char;
use complement::{ComplementChar, TsComplementArrangement};
use index_types::{ArrangementCharColumn, ArrangementColumn, SourceColumn, TsInnerIdentifier};
use inner::{TsInner, TsInnerArrangement};
use lib_tsalign::a_star_aligner::template_switch_distance::{
    AlignmentType, TemplateSwitchSecondary,
};
use log::debug;
use source::{SourceChar, TsSourceArrangement};
use tagged_vec::TaggedVec;
use template_switch::TemplateSwitch;

use crate::error::Result;

pub mod character;
pub mod complement;
pub mod index_types;
pub mod inner;
pub mod row;
pub mod source;
pub mod template_switch;

pub struct TsArrangement {
    source: TsSourceArrangement,
    complement: TsComplementArrangement,
    inner: TsInnerArrangement,
}

impl TsArrangement {
    pub fn new(
        reference_alignment_offset: usize,
        query_alignment_offset: usize,
        reference_length: usize,
        query_length: usize,
        alignment: impl IntoIterator<Item = AlignmentType>,
        visualise_equal_cost_ranges: bool,
    ) -> Result<Self> {
        let mut template_switches = Vec::new();
        let mut source = TsSourceArrangement::new(
            reference_alignment_offset,
            query_alignment_offset,
            reference_length,
            query_length,
            alignment,
            &mut template_switches,
        )?;
        let mut complement = TsComplementArrangement::new(&source);
        let inner = TsInnerArrangement::new(
            &mut source,
            &mut complement,
            template_switches,
            visualise_equal_cost_ranges,
        );

        Ok(Self {
            source,
            complement,
            inner,
        })
    }

    /// Removes columns that contain only blanks and hidden characters.
    pub fn remove_empty_columns(&mut self) {
        let mut remove_columns = Vec::new();

        'column_iter: for column in self.reference().iter_indices() {
            if !self.reference()[column].is_blank_or_hidden() {
                continue;
            }
            if !self.query()[column].is_blank_or_hidden() {
                continue;
            }
            if !self.reference_complement()[column].is_blank_or_hidden() {
                continue;
            }
            if !self.query_complement()[column].is_blank_or_hidden() {
                continue;
            }
            for inner in self.inner.inners().iter_values() {
                if !inner.sequence()[column].is_blank_or_hidden() {
                    continue 'column_iter;
                }
            }

            remove_columns.push(column);
        }

        let remove_columns = remove_columns;
        debug!("Removing columns: {remove_columns:?}");

        let removed_hidden_chars = self.source.remove_columns(remove_columns.iter().copied());
        self.complement
            .remove_columns(remove_columns.iter().copied());
        self.inner
            .remove_columns(remove_columns.iter().copied(), &removed_hidden_chars);
    }

    /// Unhides all characters of a complement, if any character of the complement is visible.
    pub fn show_complete_complements_if_used(&mut self) {
        let show = |sequence: &mut TaggedVec<ArrangementColumn, ComplementChar>| {
            if sequence.iter_values().any(Char::is_visible_char) {
                sequence.iter_values_mut().for_each(|c| {
                    if c.is_char() {
                        c.show()
                    }
                })
            }
        };

        show(self.complement.reference_complement_mut());
        show(self.complement.query_complement_mut());
    }

    /// Removes the columns from the arrangement that are further than `context_character_amount` characters away from the first and last TSM-related columns.
    /// Returns the source column ranges that are still included in the arrangement after the removal.
    /// The first range is the reference source column range, the second range is the query source column range.
    pub fn limit_context_to(
        &mut self,
        context_character_amount: usize,
    ) -> (Range<SourceColumn>, Range<SourceColumn>) {
        let first_inner_column = self.first_interesting_column();
        let last_inner_column = self.last_interesting_column();
        let first_printed_source_column_inclusive =
            first_inner_column.saturating_sub(context_character_amount);
        let last_printed_source_column_exclusive = last_inner_column
            .saturating_add(1usize)
            .saturating_add(context_character_amount);

        let result = (
            first_printed_source_column_inclusive
                ..last_printed_source_column_exclusive.min(self.source.reference_length().into()),
            first_printed_source_column_inclusive
                ..last_printed_source_column_exclusive.min(self.source.query_length().into()),
        );

        let first_printed_arrangement_column_inclusive = self
            .reference_source_to_arrangement_column(first_printed_source_column_inclusive)
            .min(self.query_source_to_arrangement_column(first_printed_source_column_inclusive));
        let last_printed_arrangement_column_exclusive = self
            .reference_source_to_arrangement_column(
                last_printed_source_column_exclusive.min(self.source.reference_length().into()),
            )
            .max(self.query_source_to_arrangement_column(
                last_printed_source_column_exclusive.min(self.source.query_length().into()),
            ));
        self.remove_column_range(last_printed_arrangement_column_exclusive..);
        self.remove_column_range(..first_printed_arrangement_column_inclusive);

        result
    }

    pub fn remove_column_range(&mut self, range: impl RangeBounds<ArrangementColumn> + Debug) {
        debug!("Removing column range: {range:?}");
        let range_start = match range.start_bound() {
            Bound::Included(inclusive) => *inclusive,
            Bound::Excluded(exclusive) => *exclusive + 1usize,
            Bound::Unbounded => 0usize.into(),
        };
        let range_end = match range.end_bound() {
            Bound::Included(inclusive) => *inclusive + 1usize,
            Bound::Excluded(exclusive) => *exclusive,
            Bound::Unbounded => self.width().into(),
        };
        let remove_columns = || (range_start.primitive()..range_end.primitive()).map(Into::into);

        let removed_hidden_chars = self.source.remove_columns(remove_columns());
        self.complement.remove_columns(remove_columns());
        self.inner
            .remove_columns(remove_columns(), &removed_hidden_chars);
    }

    pub fn reference(&self) -> &TaggedVec<ArrangementColumn, SourceChar> {
        self.source.reference()
    }

    pub fn query(&self) -> &TaggedVec<ArrangementColumn, SourceChar> {
        self.source.query()
    }

    pub fn reference_complement(&self) -> &TaggedVec<ArrangementColumn, ComplementChar> {
        self.complement.reference_complement()
    }

    pub fn query_complement(&self) -> &TaggedVec<ArrangementColumn, ComplementChar> {
        self.complement.query_complement()
    }

    pub fn inners(&self) -> &TaggedVec<TsInnerIdentifier, TsInner> {
        self.inner.inners()
    }

    pub fn reference_inners(
        &self,
    ) -> impl DoubleEndedIterator<Item = (TsInnerIdentifier, &TsInner)> {
        self.inner.reference_inners()
    }

    pub fn query_inners(&self) -> impl DoubleEndedIterator<Item = (TsInnerIdentifier, &TsInner)> {
        self.inner.query_inners()
    }

    pub fn reference_complement_inners(
        &self,
    ) -> impl DoubleEndedIterator<Item = (TsInnerIdentifier, &TsInner)> {
        self.inner.reference_complement_inners()
    }

    pub fn query_complement_inners(
        &self,
    ) -> impl DoubleEndedIterator<Item = (TsInnerIdentifier, &TsInner)> {
        self.inner.query_complement_inners()
    }

    pub fn template_switches(&self) -> impl Iterator<Item = (TsInnerIdentifier, &TemplateSwitch)> {
        self.inners()
            .iter()
            .map(|(identifier, inner)| (identifier, inner.template_switch()))
    }

    pub fn width(&self) -> usize {
        self.source.reference().len()
    }

    pub fn reference_arrangement_char_to_arrangement_column(
        &self,
        column: ArrangementCharColumn,
    ) -> ArrangementColumn {
        self.source
            .reference_arrangement_char_to_arrangement_column(column)
    }

    pub fn query_arrangement_char_to_arrangement_column(
        &self,
        column: ArrangementCharColumn,
    ) -> ArrangementColumn {
        self.source
            .query_arrangement_char_to_arrangement_column(column)
    }

    pub fn reference_source_to_arrangement_column(
        &self,
        column: SourceColumn,
    ) -> ArrangementColumn {
        self.source.reference_source_to_arrangement_column(column)
    }

    pub fn query_source_to_arrangement_column(&self, column: SourceColumn) -> ArrangementColumn {
        self.source.query_source_to_arrangement_column(column)
    }

    pub fn reference_arrangement_to_source_column(
        &self,
        column: ArrangementColumn,
    ) -> SourceColumn {
        self.source.reference_arrangement_to_source_column(column)
    }

    pub fn query_arrangement_to_source_column(&self, column: ArrangementColumn) -> SourceColumn {
        self.source.query_arrangement_to_source_column(column)
    }

    pub fn try_reference_arrangement_to_source_column(
        &self,
        column: ArrangementColumn,
    ) -> Option<SourceColumn> {
        self.source
            .try_reference_arrangement_to_source_column(column)
    }

    pub fn try_query_arrangement_to_source_column(
        &self,
        column: ArrangementColumn,
    ) -> Option<SourceColumn> {
        self.source.try_query_arrangement_to_source_column(column)
    }

    pub fn secondary_source_to_arrangement_column(
        &self,
        column: SourceColumn,
        secondary: TemplateSwitchSecondary,
    ) -> ArrangementColumn {
        match secondary {
            TemplateSwitchSecondary::Reference => {
                self.source.reference_source_to_arrangement_column(column)
            }
            TemplateSwitchSecondary::Query => {
                self.source.query_source_to_arrangement_column(column)
            }
        }
    }

    pub fn reference_arrangement_char_to_source_column(
        &self,
        column: ArrangementCharColumn,
    ) -> SourceColumn {
        self.source
            .reference_arrangement_char_to_source_column(column)
    }

    pub fn query_arrangement_char_to_source_column(
        &self,
        column: ArrangementCharColumn,
    ) -> SourceColumn {
        self.source.query_arrangement_char_to_source_column(column)
    }

    pub fn inner_first_non_blank_column(
        &self,
        inner_identifier: TsInnerIdentifier,
    ) -> ArrangementColumn {
        self.inner.inner_first_non_blank_column(inner_identifier)
    }

    pub fn inner_last_non_blank_column(
        &self,
        inner_identifier: TsInnerIdentifier,
    ) -> ArrangementColumn {
        self.inner.inner_last_non_blank_column(inner_identifier)
    }

    /// Returns the index of the first column that is related to a TSM.
    pub fn first_interesting_column(&self) -> SourceColumn {
        self.inners()
            .iter_values()
            .map(|inner| {
                [
                    self.reference_arrangement_char_to_source_column(
                        inner.template_switch().sp1_reference,
                    ),
                    self.query_arrangement_char_to_source_column(inner.template_switch().sp1_query),
                    inner.template_switch().sp2_secondary,
                    inner.template_switch().sp3_secondary,
                    self.reference_arrangement_char_to_source_column(
                        inner.template_switch().sp4_reference,
                    ),
                    self.query_arrangement_char_to_source_column(inner.template_switch().sp4_query),
                    inner
                        .sequence()
                        .iter_values()
                        .filter_map(|c| {
                            if c.is_gap_or_blank() {
                                None
                            } else {
                                Some(c.source_column())
                            }
                        })
                        .next()
                        .unwrap(),
                ]
                .into_iter()
                .min()
                .unwrap()
            })
            .min()
            .unwrap_or(0.into())
    }

    /// Returns the index of the last column that is related to a TSM.
    pub fn last_interesting_column(&self) -> SourceColumn {
        self.inners()
            .iter_values()
            .map(|inner| {
                [
                    self.reference_arrangement_char_to_source_column(
                        inner.template_switch().sp1_reference,
                    )
                    .saturating_sub(1),
                    self.query_arrangement_char_to_source_column(inner.template_switch().sp1_query)
                        .saturating_sub(1),
                    inner.template_switch().sp2_secondary.saturating_sub(1),
                    inner.template_switch().sp3_secondary.saturating_sub(1),
                    self.reference_arrangement_char_to_source_column(
                        inner.template_switch().sp4_reference,
                    )
                    .saturating_sub(1),
                    self.query_arrangement_char_to_source_column(inner.template_switch().sp4_query)
                        .saturating_sub(1),
                    inner
                        .sequence()
                        .iter_values()
                        .rev()
                        .filter_map(|c| {
                            if c.is_gap_or_blank() {
                                None
                            } else {
                                Some(c.source_column())
                            }
                        })
                        .next()
                        .unwrap(),
                ]
                .into_iter()
                .max()
                .unwrap()
            })
            .max()
            .unwrap_or(
                self.source
                    .reference_length()
                    .max(self.source.query_length())
                    .into(),
            )
    }
}