On This Page
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package bio_io
A record type for Btab (Blast-tab) files
Overview
Each record represents a "hit", or one query-target pair as returned by the homology search tool.
These records are output by many homology search tools. It is in the style of BLAST's `outfmt 6`, but with names that match MMseqs2.
Additionally, it handles cases in which query length and target length are included (in the style of mmseqs easy-search --format-mode 2).
API
val sexp_of_t : t -> Sexplib0.Sexp.tCreating records
val of_string : Base.string -> tof_string s creates a new t from tab-delimeted string s. Will raise if the format of s is bad.
Valid strings are tab-delimited with either 12 or 14 fields.
The 12 field variants fields should be query, target, pident, alnlen, mismatch, gapopen, qstart, qend, tstart, tend, evalue, and bits, in that order. It is in the style of `outfmt 6` from BLAST and related tools.
The 14 field variant should have the same 12 fields plus qlen and tlen. It is like the output of mmseqs with --format-mode 2.
val to_string : t -> Base.stringto_string t creates a new "ready to print" tab-delimited string representation of t.
Accessing fields
val query : t -> Base.stringquery t returns the query sequence of the search record.
val target : t -> Base.stringtarget t returns the target (a.k.a subject) sequence of the search record.
val pident : t -> Base.floatpident t returns the percent identity of the hit.
Note that no processing is done. So if your software returns a percentage from 0 to 100, this value will be from 0 to 100. If your software returns a fraction from 0 to 1, then this value will range from 0 to 1.
val alnlen : t -> Base.intalnlen t returns the length of the alignment.
val mismatch : t -> Base.intmismatch t returns the number of mismatches.
val gapopen : t -> Base.intgapopen t returns the number of gap openings.
val qstart : t -> Base.intqstart t returns the start position of the aligment in the query sequence.
Note that no processing is done. If the input file has 1-based coordinates, then this will also have 1-based coordinates. This also holds for qend, tstart, and tend.
val qend : t -> Base.intqend t returns the end position of the aligment in the query sequence.
val tstart : t -> Base.inttstart t returns the start position of the aligment in the target sequence.
val tend : t -> Base.inttend t returns the end position of the aligment in the target sequence.
val evalue : t -> Base.floatevalue t returns the expect value of the hit.
val bits : t -> Base.floatevalue t returns the bit-score of the hit.
val qlen : t -> Base.int Base.optionqlen t returns the length of the query sequence if it was present in the input file.
val tlen : t -> Base.int Base.optiontlen t returns the length of the target sequence if it was present in the input file.
Parsed records
module Parsed : sig ... endA fully parsed Btab record.
On This Page