class
HTS::Bam::Mpileup
- HTS::Bam::Mpileup
- Reference
- Object
Overview
High-level mpileup iterator over multiple BAM/CRAM inputs. Yields an Array of Pileup::Column (one per input) for each position.
Included Modules
- Enumerable(Array(HTS::Bam::Pileup::Column))
Defined in:
hts/bam/mpileup.crConstructors
-
.new(inputs : Array(Bam), maxcnt : Int32 | Nil = nil, overlaps : Bool = false)
Minimal constructor: accept Array(Bam).
Class Method Summary
-
.open(inputs : Array(Bam), maxcnt : Int32 | Nil = nil, overlaps : Bool = false, &)
Open an Mpileup iterator with block (RAII style)
Instance Method Summary
- #close : Nil
-
#each(&block : Array(HTS::Bam::Pileup::Column) -> ) : Nil
Iterate and yield per-position columns array (aligned by tid,pos across inputs)
- #finalize
Constructor Detail
Minimal constructor: accept Array(Bam). (String inputs or regions can be added later.)
Class Method Detail
Open an Mpileup iterator with block (RAII style)
Instance Method Detail
def each(&block : Array(HTS::Bam::Pileup::Column) -> ) : Nil
#
Iterate and yield per-position columns array (aligned by tid,pos across inputs)