package biocaml

You can search for identifiers within the package.

in-package search v0.2.0

The OCaml Bioinformatics Library

Install

Dune Dependency

biocaml.org Readme Edit opam file Versions (5)

Authors

Maintainers

B

biocaml@googlegroups.com

Sources

v0.10.1.tar.gz

md5=4cf944bcae5d36bf47b67f6bcb2455d7

sha512=0262b5768aefd7c080f664c46c88876fce9a658cc6a87358a77b7112c49ae3042e7ab542e76be5738fbaeda853149b308b48d4897960b5c7ae3b4da71d978bd8

doc/biocaml.unix/Biocaml_unix/Bam/Alignment0/index.html

Module `Bam.Alignment0`

Representation of partially parsed alignments. When traversing a BAM file for a specific calculation, it may be that only some fields of the alignment records are actually used. In that case, it can be significantly faster to use this representation. As a downside, some encoding errors in the BAM file can go unnoticed.

type t

include Ppx_sexp_conv_lib.Sexpable.S with type t := t

val t_of_sexp : Sexplib0.Sexp.t -> t

val sexp_of_t : t -> Sexplib0.Sexp.t

val qname : t -> string option

val flags : t -> Sam.Flags.t Core_kernel.Or_error.t

val rname : t -> Header.t -> string option Core_kernel.Or_error.t

val pos : t -> int option

Positions are 0-based, -1 if undefined

val mapq : t -> int option

val cigar : t -> Sam.cigar_op list Core_kernel.Or_error.t

val rnext : t -> Header.t -> Sam.rnext option Core_kernel.Or_error.t

val pnext : t -> int option

val tlen : t -> int option

val seq : t -> string option

val qual : t -> Phred_score.t list Core_kernel.Or_error.t

val optional_fields : t -> Sam.optional_field list Core_kernel.Or_error.t

val decode : t -> Header.t -> alignment Core_kernel.Or_error.t

val encode : alignment -> Header.t -> t Core_kernel.Or_error.t