Expand description
Utility module: Common bioinformatics and string processing functions.
This module provides the AlignmentRecord abstraction and helper functions
like reverse complementation and memory unit parsing.
Structs§
- Alignment
Record - Unified representation of one alignment record used by Scan1 and Scan2.
Constants§
- MIN_
BAM_ SHARD_ BYTES - Smallest compressed BAM shard size worth parallelizing.
Functions§
- alignment_
short_ cs - Builds a minimap2-compatible short-form cs payload for one mapper alignment.
- bam_
shard_ count - Chooses a safe BAM shard count for BGZF-parallel Scan1/Scan2 processing.
- bsj1_
path_ for_ output - Returns the merged Scan1 BSJ output path for one CLI prefix.
- bsj2_
path_ for_ output - Returns the basename used for Scan2 shard-local BSJ spill files.
- bsj_
is_ summary_ priority - Returns whether a BSJ row should participate in the Java-compatible summary.
- bsj_
path_ for_ output - Returns the final combined BSJ output path for one CLI prefix.
- bsj_
payload_ start - Returns the first field index of the legacy BSJ payload.
- clip_
sequence_ payload - Encodes only recoverable soft-clipped bases for segment-evidence sidecars.
- fsj_
path_ for_ output - Returns the basename used for FSJ shard-local spill files.
- is_
bsj_ mate_ label - Returns whether a field is the mate label used by the expanded BSJ protocol.
- local_
clip_ evidence_ lines - Adds pseudo-alignment rows for local clip evidence accepted with BSJ calls.
- log_
path_ for_ output - Returns the sidecar log path for one CLI prefix.
- parse_
cigar_ ops_ basic - Parses a SAM-like CIGAR into
(length, op)pairs for sidecar formatting. - parse_
mem_ str - Parses memory strings like
2G,512M, or1024Kinto bytes. - part_
path - Returns the temporary spill-file path for one shard-local intermediate.
- perf_
path_ for_ output - Returns the profiling report path for one CLI prefix.
- result_
path_ for_ output - Returns the final Summary output path for one CLI
-o/--outprefix. - reverse_
complement - Returns the reverse complement of a DNA sequence.
- segments1_
path_ for_ output - Returns the Scan1 segments-evidence sidecar path for one CLI prefix.
- segments2_
path_ for_ output - Returns the Scan2 segments-evidence sidecar path for one CLI prefix.
- segments_
non_ bsj_ path_ for_ output - Returns the Scan2 non-BSJ segments sidecar path for one CLI prefix.
- trace_
path_ for_ output - Returns the targeted read-trace path for one CLI prefix.