class HTS::Bam::Record

Defined in:

hts/bam/record.cr

Constant Summary

SEQ_NT16_STR = "=ACMGRSVTWYHKDBN"

Constructors

Instance Method Summary

Constructor Detail

def self.new(header : Bam::Header, bam1_t : Pointer(HTS::LibHTS::Bam1T)) #

[View source]
def self.new(header : Bam::Header) #

[View source]

Instance Method Detail

def aux(str) #

[View source]
def aux_char(str) #

[View source]
def aux_float(str) #

[View source]
def aux_int(str) #

Retrun Int64


[View source]
def aux_string(str) #

[View source]
def base(n) #

return only the base of the requested index "i" of the query sequence.


[View source]
def base_qual(n) #

return only the base quality of the requested index "i" of the query sequence.


[View source]
def bin #

[View source]
def bin=(bin) #

[View source]
def chrom #

returns the chromosome or '' if not mapped.


[View source]
def cigar #

returns a Cigar object.


[View source]
def clone #

[View source]
def contig #

returns the mate chromosome or '' if not mapped.


[View source]
def duplicate? #

[View source]
def endpos #

returns end position of the read.


[View source]
def finalize #

garbagew collection


[View source]
def flag #

returns a Flag object.


[View source]
def flag=(flag : Flag) #

[View source]
def flag=(flag) #

[View source]
def header : HTS::Bam::Header #

[View source]
def insert_size #

insert size


[View source]
def insert_size=(isize) #

[View source]
def isize #

[View source]
def isize=(isize) #

[View source]
def len #

[View source]
def mapq #

mapping quality


[View source]
def mapq=(mapq) #

[View source]
def mate_chrom #

returns the chromosome of the mate or '' if not mapped.


[View source]
def mate_contig #

[View source]
def mate_pos #

returns 0-based mate position


[View source]
def mate_pos=(mpos) #

[View source]
def mate_reverse? #

[View source]
def mate_strand #

[View source]
def mate_unmapped? #

[View source]
def mpos #

[View source]
def mpos=(mpos) #

[View source]
def mtid #

returns the tid of the mate or -1 if not mapped.


[View source]
def mtid=(mtid) #

[View source]
def paired? #

[View source]
def pos #

returns 0-based start position.


[View source]
def pos=(pos) #

[View source]
def proper_pair? #

[View source]
def qcfail? #

[View source]
def qlen #

[View source]
def qname #

returns the query name.


[View source]
def qname=(name) #

[View source]
def qual #

return the base qualities


[View source]
def qual_string #

[View source]
def read1? #

[View source]
def read2? #

[View source]
def reverse? #

[View source]
def rlen #

[View source]
def secondary? #

[View source]
def seq #

return the read sequence


[View source]
def sequence #

[View source]
def strand #

[View source]
def supplementary? #

[View source]
def tid #

returns the tid of the record or -1 if not mapped.


[View source]
def tid=(tid) #

[View source]
def to_s(io : IO) #
Description copied from class Reference

Appends a short String representation of this object which includes its class name and its object address.

class Person
  def initialize(@name : String, @age : Int32)
  end
end

Person.new("John", 32).to_s # => #<Person:0x10a199f20>

[View source]
def to_unsafe : Pointer(HTS::LibHTS::Bam1T) #

[View source]
def unmapped? #

[View source]