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.ez/Biocaml_ez/Bam/index.html

Module `Biocaml_ez.Bam`

include module type of struct include Biocaml_unix.Bam end

A BAM file is composed of a header and a list of alignment records. The datatypes used in this module are based on those defined in the Sam module.

module Header = Biocaml_unix.Bam.Header

BAM header files contain a plain text SAM header, plus additional information related to the encoding of the file.

type alignment = Biocaml_unix.Sam.alignment

module Alignment0 = Biocaml_unix.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.

val read0 : 
  Core_kernel.In_channel.t ->
  (Header.t * Alignment0.t Core_kernel.Or_error.t Stream.t)
    Core_kernel.Or_error.t

read0 ic returns an error if a valid header cannot be read from ic or a pair containing a header and a stream of possibly errored (partially parsed) alignments. The stream stops after the first error.

val write0 : 
  Header.t ->
  Alignment0.t Stream.t ->
  Core_kernel.Out_channel.t ->
  unit

write0 h xs oc writes the header h and (partially parsed) alignments xs to oc.

val read : 
  Core_kernel.In_channel.t ->
  (Header.t * alignment Core_kernel.Or_error.t Stream.t) Core_kernel.Or_error.t

read ic returns an error if a valid header cannot be read from ic or a pair containing a header and a stream of possibly errored alignments. The stream stops after the first error.

val write : 
  Header.t ->
  alignment Stream.t ->
  Core_kernel.Out_channel.t ->
  unit Core_kernel.Or_error.t

write h xs oc writes the header h and the alignments xs to oc.

Low-level access

val read_header : 
  Biocaml_unix.Bgzf.in_channel ->
  Header.t Core_kernel.Or_error.t

val read_alignment : 
  Biocaml_unix.Bgzf.in_channel ->
  Alignment0.t Core_kernel.Or_error.t option

val read_alignment_stream : 
  Biocaml_unix.Bgzf.in_channel ->
  Alignment0.t Core_kernel.Or_error.t Stream.t

val with_file : 
  string ->
  f:(Header.t -> alignment CFStream.Stream.t -> 'a) ->
  'a

val with_file0 : 
  string ->
  f:(Header.t -> Alignment0.t CFStream.Stream.t -> 'a) ->
  'a