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
|
from typing import List
import pytest
from dnaio import SequenceRecord
from cutadapt.adapters import (
BackAdapter,
PrefixAdapter,
IndexedPrefixAdapters,
LinkedAdapter,
FrontAdapter,
Adapter,
RemoveBeforeMatch,
RemoveAfterMatch,
LinkedMatch,
)
from cutadapt.modifiers import (
UnconditionalCutter,
NEndTrimmer,
QualityTrimmer,
Shortener,
AdapterCutter,
PairedAdapterCutter,
ModificationInfo,
ZeroCapper,
Renamer,
ReverseComplementer,
InvalidTemplate,
PairedEndRenamer,
PairedReverseComplementer,
)
def test_unconditional_cutter():
UnconditionalCutter(length=5)
read = SequenceRecord("r1", "abcdefg")
info = ModificationInfo(read)
assert UnconditionalCutter(length=2)(read, info).sequence == "cdefg"
assert info.cut_prefix == "ab"
assert info.cut_suffix is None
info = ModificationInfo(read)
assert UnconditionalCutter(length=-2)(read, info).sequence == "abcde"
assert info.cut_suffix == "fg"
assert info.cut_prefix is None
assert UnconditionalCutter(length=100)(read, info).sequence == ""
assert UnconditionalCutter(length=-100)(read, info).sequence == ""
def test_reverse_complementer():
adapters = [
PrefixAdapter("TTATTTGTCT"),
PrefixAdapter("TCCGCACTGG"),
]
adapter_cutter = AdapterCutter(adapters, index=False)
reverse_complementer = ReverseComplementer(adapter_cutter)
read = SequenceRecord("r", "ttatttgtctCCAGCTTAGACATATCGCCT")
info = ModificationInfo(read)
trimmed = reverse_complementer(read, info)
assert trimmed.sequence == "CCAGCTTAGACATATCGCCT"
assert not info.is_rc
read = SequenceRecord("r", "CAACAGGCCACATTAGACATATCGGATGGTagacaaataa")
info = ModificationInfo(read)
trimmed = reverse_complementer(read, info)
assert trimmed.sequence == "ACCATCCGATATGTCTAATGTGGCCTGTTG"
assert info.is_rc
def test_zero_capper():
zc = ZeroCapper()
read = SequenceRecord("r1", "ACGT", "# !%")
result = zc(read, ModificationInfo(read))
assert result.sequence == "ACGT"
assert result.qualities == "#!!%"
def test_nend_trimmer():
trimmer = NEndTrimmer()
seqs = ["NNNNAAACCTTGGNNN", "NNNNAAACNNNCTTGGNNN", "NNNNNN"]
trims = ["AAACCTTGG", "AAACNNNCTTGG", ""]
for seq, trimmed in zip(seqs, trims):
_seq = SequenceRecord("read1", seq, qualities="#" * len(seq))
_trimmed = SequenceRecord("read1", trimmed, qualities="#" * len(trimmed))
assert trimmer(_seq, ModificationInfo(_seq)) == _trimmed
def test_quality_trimmer():
read = SequenceRecord("read1", "ACGTTTACGTA", "##456789###")
qt = QualityTrimmer(10, 10, 33)
assert qt(read, ModificationInfo(read)) == SequenceRecord(
"read1", "GTTTAC", "456789"
)
qt = QualityTrimmer(0, 10, 33)
assert qt(read, ModificationInfo(read)) == SequenceRecord(
"read1", "ACGTTTAC", "##456789"
)
qt = QualityTrimmer(10, 0, 33)
assert qt(read, ModificationInfo(read)) == SequenceRecord(
"read1", "GTTTACGTA", "456789###"
)
def test_shortener():
read = SequenceRecord("read1", "ACGTTTACGTA", "##456789###")
shortener = Shortener(0)
assert shortener(read, ModificationInfo(read)) == SequenceRecord("read1", "", "")
shortener = Shortener(1)
assert shortener(read, ModificationInfo(read)) == SequenceRecord("read1", "A", "#")
shortener = Shortener(5)
assert shortener(read, ModificationInfo(read)) == SequenceRecord(
"read1", "ACGTT", "##456"
)
shortener = Shortener(100)
assert shortener(read, ModificationInfo(read)) == read
def test_adapter_cutter_indexing():
adapters = [
PrefixAdapter(sequence, max_errors=1, indels=False)
for sequence in ["ACGAT", "GGAC", "TTTACTTA", "TAACCGGT", "GTTTACGTA", "CGATA"]
]
ac = AdapterCutter(adapters)
assert len(ac.adapters) == 1
assert isinstance(ac.adapters[0], IndexedPrefixAdapters)
ac = AdapterCutter(adapters, index=False)
assert len(ac.adapters) == len(adapters)
class TestPairedAdapterCutter:
@pytest.mark.parametrize(
"action,expected_trimmed1,expected_trimmed2",
[
(None, "CCCCGGTTAACCCC", "TTTTAACCGGTTTT"),
("trim", "CCCC", "TTTT"),
("lowercase", "CCCCggttaacccc", "TTTTaaccggtttt"),
("mask", "CCCCNNNNNNNNNN", "TTTTNNNNNNNNNN"),
("retain", "CCCCGGTTAA", "TTTTAACCGG"),
],
)
def test_actions(self, action, expected_trimmed1, expected_trimmed2):
a1 = BackAdapter("GGTTAA")
a2 = BackAdapter("AACCGG")
s1 = SequenceRecord("name", "CCCCGGTTAACCCC")
s2 = SequenceRecord("name", "TTTTAACCGGTTTT")
pac = PairedAdapterCutter([a1], [a2], action=action)
info1 = ModificationInfo(s1)
info2 = ModificationInfo(s2)
trimmed1, trimmed2 = pac(s1, s2, info1, info2)
assert expected_trimmed1 == trimmed1.sequence
assert expected_trimmed2 == trimmed2.sequence
def test_multiple_occurrences(self):
r1_a1 = BackAdapter("AAAAAA")
r1_a2 = BackAdapter("CCCC")
r2_a1 = BackAdapter("GGGG")
r2_a2 = BackAdapter("TTTT")
s1 = SequenceRecord("name", "TTAAAAAATTCCCCTT")
s2 = SequenceRecord("name", "ACACTTTTACAC")
pac = PairedAdapterCutter([r1_a1, r1_a2], [r2_a1, r2_a2], action="lowercase")
info1 = ModificationInfo(s1)
info2 = ModificationInfo(s2)
trimmed1, trimmed2 = pac(s1, s2, info1, info2)
assert len(info1.matches) == 1 and info1.matches[0].adapter is r1_a2
assert len(info2.matches) == 1 and info2.matches[0].adapter is r2_a2
assert "TTAAAAAATTcccctt" == trimmed1.sequence
assert "ACACttttacac" == trimmed2.sequence
def test_retain_times():
with pytest.raises(ValueError) as e:
AdapterCutter([BackAdapter("ACGT")], times=2, action="retain")
assert "cannot be combined with times" in e.value.args[0]
def test_action_retain():
back = BackAdapter("AACCGG")
ac = AdapterCutter([back], action="retain")
seq = SequenceRecord("r1", "ATTGCCAACCGGTATATAT")
info = ModificationInfo(seq)
trimmed = ac(seq, info)
assert "ATTGCCAACCGG" == trimmed.sequence
@pytest.mark.parametrize(
"s,expected",
[
("ATTATTggttaaccAAAAAaaccggTATT", "ggttaaccAAAAAaaccgg"),
("AAAAAaaccggTATT", "AAAAAaaccgg"),
("ATTATTggttaaccAAAAA", "ggttaaccAAAAA"),
("ATTATT", "ATTATT"),
],
)
def test_linked_action_retain(s, expected):
front = FrontAdapter("GGTTAACC")
back = BackAdapter("AACCGG")
adapters: List[Adapter] = [
LinkedAdapter(
front, back, front_required=False, back_required=False, name="linked"
)
]
ac = AdapterCutter(adapters, action="retain")
seq = SequenceRecord("r1", s)
info = ModificationInfo(seq)
trimmed = ac(seq, info)
assert expected == trimmed.sequence
class TestRenamer:
def test_invalid_template_variable(self):
with pytest.raises(InvalidTemplate):
Renamer("{id} {invalid}")
def test_header_template_variable(self):
renamer = Renamer("{header} extra")
read = SequenceRecord("theid thecomment", "ACGT")
info = ModificationInfo(read)
assert renamer(read, info).name == "theid thecomment extra"
def test_id_template_variable(self):
renamer = Renamer("{id} extra")
read = SequenceRecord("theid thecomment", "ACGT")
info = ModificationInfo(read)
assert renamer(read, info).name == "theid extra"
def test_tab_escape(self):
renamer = Renamer(r"{id} extra\tand a tab")
read = SequenceRecord("theid thecomment", "ACGT")
info = ModificationInfo(read)
assert renamer(read, info).name == "theid extra\tand a tab"
def test_comment_template_variable(self):
renamer = Renamer("{id}_extra {comment}")
read = SequenceRecord("theid thecomment", "ACGT")
info = ModificationInfo(read)
assert renamer(read, info).name == "theid_extra thecomment"
def test_comment_template_variable_missing_comment(self):
renamer = Renamer("{id}_extra {comment}")
read = SequenceRecord("theid", "ACGT")
info = ModificationInfo(read)
assert renamer(read, info).name == "theid_extra "
def test_cut_prefix_template_variable(self):
renamer = Renamer("{id}_{cut_prefix} {comment}")
read = SequenceRecord("theid thecomment", "ACGT")
info = ModificationInfo(read)
info.cut_prefix = "TTAAGG"
assert renamer(read, info).name == "theid_TTAAGG thecomment"
def test_cut_suffix_template_variable(self):
renamer = Renamer("{id}_{cut_suffix} {comment}")
read = SequenceRecord("theid thecomment", "ACGT")
info = ModificationInfo(read)
info.cut_suffix = "TTAAGG"
assert renamer(read, info).name == "theid_TTAAGG thecomment"
def test_rc_template_variable(self):
renamer = Renamer("{id} rc={rc} {comment}")
read = SequenceRecord("theid thecomment", "ACGT")
info = ModificationInfo(read)
assert renamer(read, info).name == "theid rc= thecomment"
read = SequenceRecord("theid thecomment", "ACGT")
info.is_rc = True
assert renamer(read, info).name == "theid rc=rc thecomment"
def test_match_sequence(self):
sequence = "TTTTCCCCACGTGGGG"
read = SequenceRecord("theid thecomment", sequence)
adapter = BackAdapter("AGGT")
info = ModificationInfo(read)
info.matches.append(
RemoveBeforeMatch(
astart=0,
astop=4,
rstart=8,
rstop=12,
score=3,
errors=1,
adapter=adapter,
sequence=sequence,
)
)
renamer = Renamer("{header} match={match_sequence}")
renamer(read, info)
assert read.name == "theid thecomment match=ACGT"
def test_match_sequence_linked_match(self):
sequence = "TATTCCCCACGTGGGG"
read = SequenceRecord("theid thecomment", sequence)
adapter1 = PrefixAdapter("TTTT")
adapter2 = BackAdapter("AGGT")
linked_adapter = LinkedAdapter(
adapter1,
adapter2,
front_required=True,
back_required=False,
name="name",
)
info = ModificationInfo(read)
before_match = RemoveBeforeMatch(
astart=0,
astop=4,
rstart=0,
rstop=4,
score=3,
errors=1,
adapter=adapter1,
sequence=sequence,
)
after_match = RemoveAfterMatch(
astart=0,
astop=4,
rstart=4,
rstop=8,
score=3,
errors=1,
adapter=adapter2,
sequence=sequence[4:],
)
info.matches.append(LinkedMatch(before_match, after_match, linked_adapter))
renamer = Renamer("{header} match={match_sequence}")
renamer(read, info)
assert read.name == "theid thecomment match=TATT,ACGT"
class TestPairedEndRenamer:
def test_invalid_template_variable(self):
with pytest.raises(InvalidTemplate):
PairedEndRenamer("{id} {invalid}")
def test_tab_escape(self):
renamer = PairedEndRenamer(r"{id} {comment}\tand a tab")
r1 = SequenceRecord("theid comment1", "ACGT")
r2 = SequenceRecord("theid comment2", "ACGT")
info1 = ModificationInfo(r1)
info2 = ModificationInfo(r2)
renamed1, renamed2 = renamer(r1, r2, info1, info2)
assert renamed1.name == "theid comment1\tand a tab"
assert renamed2.name == "theid comment2\tand a tab"
def test_ids_not_identical(self):
renamer = PairedEndRenamer("{id} abc {comment} xyz")
r1 = SequenceRecord("theid_a cmtx", "ACGT")
r2 = SequenceRecord("theid_b cmty", "ACGT")
info1 = ModificationInfo(r1)
info2 = ModificationInfo(r2)
with pytest.raises(ValueError) as e:
renamer(r1, r2, info1, info2)
assert "not identical" in e.value.args[0]
def test_comment(self):
renamer = PairedEndRenamer("{id} abc {comment} xyz")
r1 = SequenceRecord("theid cmtx", "ACGT")
r2 = SequenceRecord("theid cmty", "ACGT")
info1 = ModificationInfo(r1)
info2 = ModificationInfo(r2)
renamed1, renamed2 = renamer(r1, r2, info1, info2)
assert renamed1.name == "theid abc cmtx xyz"
assert renamed2.name == "theid abc cmty xyz"
def test_r1_comment(self):
renamer = PairedEndRenamer("{id} abc {r1.comment} xyz")
r1 = SequenceRecord("theid cmtx", "ACGT")
r2 = SequenceRecord("theid cmty", "ACGT")
info1 = ModificationInfo(r1)
info2 = ModificationInfo(r2)
renamed1, renamed2 = renamer(r1, r2, info1, info2)
assert renamed1.name == "theid abc cmtx xyz"
assert renamed2.name == "theid abc cmtx xyz"
def test_r2_comment(self):
renamer = PairedEndRenamer("{id} abc {r2.comment} xyz")
r1 = SequenceRecord("theid cmtx", "ACGT")
r2 = SequenceRecord("theid cmty", "ACGT")
info1 = ModificationInfo(r1)
info2 = ModificationInfo(r2)
renamed1, renamed2 = renamer(r1, r2, info1, info2)
assert renamed1.name == "theid abc cmty xyz"
assert renamed2.name == "theid abc cmty xyz"
def test_read_number(self):
renamer = PairedEndRenamer("{id} read no. is: {rn}")
r1 = SequenceRecord("theid cmtx", "ACGT")
r2 = SequenceRecord("theid cmty", "ACGT")
info1 = ModificationInfo(r1)
info2 = ModificationInfo(r2)
renamed1, renamed2 = renamer(r1, r2, info1, info2)
assert renamed1.name == "theid read no. is: 1"
assert renamed2.name == "theid read no. is: 2"
def test_match_sequence(self):
r1 = SequenceRecord("theid first", "AACC")
info1 = ModificationInfo(r1)
info1.matches.append(
RemoveBeforeMatch(
astart=2,
astop=4,
rstart=1,
rstop=3,
score=1,
errors=1,
adapter=FrontAdapter("AT"),
sequence="AACC",
)
)
r2 = SequenceRecord("theid second", "GGTT")
info2 = ModificationInfo(r2)
info2.matches.append(
RemoveBeforeMatch(
astart=2,
astop=4,
rstart=1,
rstop=3,
score=1,
errors=1,
adapter=FrontAdapter("GA"),
sequence="GGTT",
)
)
renamer = PairedEndRenamer("{header} s={match_sequence}")
renamed1, renamed2 = renamer(r1[:], r2[:], info1, info2)
assert renamed1.name == "theid first s=AC"
assert renamed2.name == "theid second s=GT"
renamer = PairedEndRenamer("{header} s={r1.match_sequence}")
renamed1, renamed2 = renamer(r1[:], r2[:], info1, info2)
assert renamed1.name == "theid first s=AC"
assert renamed2.name == "theid second s=AC"
renamer = PairedEndRenamer("{header} s={r2.match_sequence}")
renamed1, renamed2 = renamer(r1[:], r2[:], info1, info2)
assert renamed1.name == "theid first s=GT"
assert renamed2.name == "theid second s=GT"
def test_paired_reverse_complementer():
cutter1 = AdapterCutter([PrefixAdapter("AACC")], index=False)
cutter2 = AdapterCutter([PrefixAdapter("GGCC")], index=False)
revcomper = PairedReverseComplementer(cutter1, cutter2)
# Forward (normal)
r1 = SequenceRecord("a", "AACCAAAAA")
r2 = SequenceRecord("a", "GGCCTTTTT")
info1 = ModificationInfo(r1)
info2 = ModificationInfo(r2)
trimmed1, trimmed2 = revcomper(r1, r2, info1, info2)
assert trimmed1.sequence == "AAAAA"
assert trimmed2.sequence == "TTTTT"
assert trimmed1.name == "a"
assert trimmed2.name == "a"
# Reversed (R1/R2 swapped)
r1, r2 = r2, r1
info1 = ModificationInfo(r1)
info2 = ModificationInfo(r2)
trimmed1, trimmed2 = revcomper(r1, r2, info1, info2)
assert trimmed1.sequence == "AAAAA"
assert trimmed2.sequence == "TTTTT"
assert trimmed1.name == "a rc"
assert trimmed2.name == "a rc"
|