seismicrna.relate.aux package

Subpackages

• seismicrna.relate.aux.tests package
  • Submodules
    • TestCigarOp
      • TestCigarOp.ops
      • TestCigarOp.test_cigar_init_invalid()
      • TestCigarOp.test_cigar_init_valid()
      • TestCigarOp.test_cigar_lengthen()
      • TestCigarOp.test_cigar_str()
    • TestCountCigarMuts
      • TestCountCigarMuts.test_cigar_match_subst_valid()
    • TestFindCigarOpPos
      • TestFindCigarOpPos.test_cigar_m_aln_valid()
      • TestFindCigarOpPos.test_cigar_m_del_valid()
      • TestFindCigarOpPos.test_cigar_m_ins_valid()
      • TestFindCigarOpPos.test_cigar_m_mat_valid()
      • TestFindCigarOpPos.test_cigar_m_scl_valid()
      • TestFindCigarOpPos.test_cigar_m_sub_valid()
      • TestFindCigarOpPos.test_cigar_xeq_aln_valid()
      • TestFindCigarOpPos.test_cigar_xeq_del_valid()
      • TestFindCigarOpPos.test_cigar_xeq_ins_valid()
      • TestFindCigarOpPos.test_cigar_xeq_mat_valid()
      • TestFindCigarOpPos.test_cigar_xeq_scl_valid()
      • TestFindCigarOpPos.test_cigar_xeq_sub_valid()
    • TestInferRead
      • TestInferRead.assert_equal()
      • TestInferRead.assert_raise()
      • TestInferRead.test_all_match()
      • TestInferRead.test_all_match_n()
      • TestInferRead.test_delete_invalid()
      • TestInferRead.test_delete_valid()
      • TestInferRead.test_insert_bare_invalid()
      • TestInferRead.test_insert_dangling_3_invalid()
      • TestInferRead.test_insert_dangling_5_invalid()
      • TestInferRead.test_insert_deletion_invalid()
      • TestInferRead.test_insert_end3_invalid()
      • TestInferRead.test_insert_end5_invalid()
      • TestInferRead.test_insert_non_match_valid()
      • TestInferRead.test_insert_valid()
      • TestInferRead.test_low_qual_valid()
      • TestInferRead.test_nocov_valid()
      • TestInferRead.test_subst_invalid()
      • TestInferRead.test_subst_valid()
    • TestIterRelvecsAll
      • TestIterRelvecsAll.assert_equal()
      • TestIterRelvecsAll.test_length_1()
      • TestIterRelvecsAll.test_length_2()
      • TestIterRelvecsAll.test_length_3()
    • TestIterRelvecsQ53
      • TestIterRelvecsQ53.list_rels()
      • TestIterRelvecsQ53.test_a()
      • TestIterRelvecsQ53.test_aa()
      • TestIterRelvecsQ53.test_agg()
      • TestIterRelvecsQ53.test_c()
      • TestIterRelvecsQ53.test_g()
      • TestIterRelvecsQ53.test_low_qual()
      • TestIterRelvecsQ53.test_low_qual_invalid()
      • TestIterRelvecsQ53.test_n()
      • TestIterRelvecsQ53.test_t()
      • TestIterRelvecsQ53.test_type()
      • TestIterRelvecsQ53.test_xaax()

Submodules

class seismicrna.relate.aux.cigarop.CigarOp(op: str)

Bases: object

Represent one operation in a CIGAR string.

__str__()

Text that goes into the CIGAR string.

lengthen()

Lengthen the operation by 1 base call.

property op

CIGAR operation as a character.

seismicrna.relate.aux.cigarop.count_cigar_muts(cigar_string: str)

Count the mutations in a CIGAR string.

seismicrna.relate.aux.cigarop.count_cigar_read(cigar_string: str)

Count the read positions consumed by a CIGAR string.

seismicrna.relate.aux.cigarop.count_cigar_ref(cigar_string: str)

Count the reference positions consumed by a CIGAR string.

seismicrna.relate.aux.cigarop.find_cigar_op_pos(cigar_string: str, find_op: str)

Yield the position in the read of every base with a particular type of operation specified by a CIGAR string.

seismicrna.relate.aux.cigarop.op_is_mutation(op: str)

Whether the CIGAR operation is a mutation.

seismicrna.relate.aux.human.humanize_relvec(relvec: ndarray)

Translate a binary relation vector to human-readable text.

seismicrna.relate.aux.infer.infer_read(refseq: DNA, end5: int, end3: int, muts: dict[int, int], hi_qual: str = 'I', lo_qual: str = '!', ins_len: int | Sequence[int] = 1)

Infer a read sequence and quality string from a reference sequence and relation vector.

Parameters:

• refseq (DNA) – Sequence of the reference.

• end5 (int) – 5’ end of the read with respect to the reference.

• end3 (int) – 3’ end of the read with respect to the reference.

• muts (dict[int, int]) – Mutations in the read, keyed by their positions.

• hi_qual (str = MAX_QUAL) – Character to put in the quality string at every position that is high-quality according to the relation vector.

• lo_qual (str = MIN_QUAL) – Character to put in the quality string at every position that is low-quality according to the relation vector.

• ins_len (int | Sequence[int] = 1) – Number of bases to insert into the read and quality strings upon finding an insertion in the relation vector. If an integer, then insert that number of bases for every insertion. If a sequence of integers, then the ith insertion gets a number of bases equal to the ith element of ins_len.

Read Iteration Module

seismicrna.relate.aux.iterread.iter_alignments(*args, **kwargs)

For a given reference sequence, find every read that could come from the reference (with up to 2 bases inserted). For each read, yield the (possibly ambiguous) relation vector and every possible CIGAR string.

seismicrna.relate.aux.iterread.ref_to_alignments(refseq: DNA, max_ins: int | None = None, max_ins_len: int = 1, max_ins_bases: int | None = None)

For a given reference sequence, map every possible read to its CIGAR string(s) and (possibly ambiguous) relation vector.

Parameters:

• refseq (DNA) – Sequence of the reference.

• max_ins (int = 2) – Maximum number of insertions in the read. Must be ≥ 0.

• max_ins_len (int = 1) – Maximum length of (i.e. number of bases in) one insertion. Must be ≥ 1.

• max_ins_bases (int | None = None) – Maximum total number of bases inserted. Must be ≥ max_ins. If None, there is no limit.

Relate Auxiliary Module

seismicrna.relate.aux.iterrel.iter_relvecs_all(refseq: DNA, max_ins: int | None = None)

For a given reference sequence, yield every possible unambiguous relation vector that has at most two insertions.

Parameters:

• refseq (DNA) – Sequence of the reference.

• max_ins (int = 2) – Maximum number of insertions in a read.

seismicrna.relate.aux.iterrel.iter_relvecs_q53(refseq: DNA, low_qual: Sequence[int] = (), end5: int | None = None, end3: int | None = None, max_ins: int | None = None)

For a given reference sequence, yield every possible unambiguous relation vector between positions end5 and end3 that follows the given low-quality positions and has at most two insertions.

Parameters:

• refseq (DNA) – Sequence of the reference.

• low_qual (Sequence[int]) – List of positions in the read that are low-quality.

• end5 (int | None = None) – 5’ end of the read; 1-indexed with respect to refseq.

• end3 (int | None = None) – 3’ end of the read; 1-indexed with respect to refseq.

• max_ins (int | None = None) – Maximum number of insertions in the read.