package biocaml

  1. Overview
  2. Docs
The OCaml Bioinformatics Library

Install 

dune-project
 Dependency

biocaml.org Readme Edit opam file Versions (5)

Authors

  1. S
    Sebastien Mondet
  2. A
    Ashish Agarwal
  3. P
    Philippe Veber
  4. C
    Christophe Troestler
  5. S
    Sergei Lebedev
  6. D
    David Koppstein
  7. A
    Alexander Gryzlov
  8. F
    Francois Berenger

Maintainers

  1. B
    biocaml@googlegroups.com

Sources

v0.11.1.tar.gz
md5=e292efa2f61fec33dad63ec897106f59
sha512=35519bf3b1e67a9191ef9bb74eba0dae941e0d05bad89076a36f507dc5c2d105a03c1c917d5a3f7ed9d1da4acbf3199582f78c308aa2a5a22c21f743945c852b

doc/biocaml.ez/Biocaml_ez/Fasta/index.html

Module Biocaml_ez.FastaSource

include module type of struct include Biocaml_unix.Fasta end
Sourcetype header = private string list

A header is a list of comment lines.

Sourcetype item = private Biocaml_unix.Fasta.item = {
  1. description : string;
  2. sequence : string;
}
Sourcetype fmt = Biocaml_unix.Fasta.fmt = {
  1. allow_sharp_comments : bool;
  2. allow_semicolon_comments : bool;
  3. allow_empty_lines : bool;
  4. comments_only_at_top : bool;
  5. max_line_length : int option;
  6. alphabet : string option;
}
Sourceval default_fmt : fmt

Low-level Parsing

Sourcetype item0 = private [<
  1. | `Comment of string
  2. | `Empty_line
  3. | `Description of string
  4. | `Partial_sequence of string
]

An item0 is more raw than item. It is useful for parsing files with large sequences because you get the sequence in smaller pieces.

  • `Comment _ - Single comment line without the final newline. Initial comment char is retained.
  • `Empty_line - Got a line with only whitespace characters. The contents are not provided.
  • `Description _ - Single description line without the initial '>' nor final newline.
  • `Partial_sequence _ - Multiple sequential partial sequences comprise the sequence of a single item.
Sourceval parse_item0 : ?allow_sharp_comments:bool -> ?allow_semicolon_comments:bool -> ?allow_empty_lines:bool -> ?max_line_length:int -> ?alphabet:string -> Biocaml_unix.Line.t -> item0 Core_kernel.Or_error.t
Sourceval sequence_to_int_list : string -> int list
Sourceval read0 : ?start:Biocaml_unix.Pos.t -> ?allow_sharp_comments:bool -> ?allow_semicolon_comments:bool -> ?allow_empty_lines:bool -> ?max_line_length:int -> ?alphabet:string -> Core_kernel.In_channel.t -> item0 CFStream.Stream.t
Sourceval read : ?start:Biocaml_unix.Pos.t -> ?fmt:fmt -> Core_kernel.In_channel.t -> header * item CFStream.Stream.t
Sourceval with_file : ?fmt:fmt -> string -> f:(header -> item CFStream.Stream.t -> 'a) -> 'a